appc-common/src/main/java/org/openecomp/appc/exceptions/APPCException.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25
  26
  27 package org.openecomp.appc.exceptions;
  28
  29 /**
  30  * This is a base class for all APPC defined exceptions.
  31  */
  32
  33 public class APPCException extends Exception {
  34
  35     /**
  36      *
  37      */
  38     private static final long serialVersionUID = 1L;
  39
  40     /**
  41      * Constructs a new exception with null as its detail message. The cause is not initialized, and may subsequently be
  42      * initialized by a call to initCause.
  43      */
  44     public APPCException() {
  45     }
  46
  47     /**
  48      * Constructs a new exception with the specified detail message. The cause is not initialized, and may subsequently
  49      * be initialized by a call to initCause.
  50      *
  51      * @param message
  52      *            the detail message. The detail message is saved for later retrieval by the getMessage() method.
  53      */
  54     public APPCException(String message) {
  55         super(message);
  56     }
  57
  58     /**
  59      * Constructs a new exception with the specified cause and a detail message of (cause==null ? null :
  60      * cause.toString()) (which typically contains the class and detail message of cause). This constructor is useful
  61      * for exceptions that are little more than wrappers for other throwables (for example,
  62      * java.security.PrivilegedActionException).
  63      *
  64      * @param cause
  65      *            the cause (which is saved for later retrieval by the getCause() method). (A null value is permitted,
  66      *            and indicates that the cause is nonexistent or unknown.)
  67      */
  68     public APPCException(Throwable cause) {
  69         super(cause);
  70     }
  71
  72     /**
  73      *
  74      Constructs a new exception with the specified detail message and cause.
  75      * <p>
  76      * Note that the detail message associated with cause is not automatically incorporated in this exception's detail
  77      * message.
  78      * </p>
  79      *
  80      * @param message
  81      *            the detail message (which is saved for later retrieval by the getMessage() method).
  82      * @param cause
  83      *            the cause (which is saved for later retrieval by the getCause() method). (A null value is permitted,
  84      *            and indicates that the cause is nonexistent or unknown.)
  85      */
  86     public APPCException(String message, Throwable cause) {
  87         super(message, cause);
  88     }
  89
  90     /**
  91      *
  92      Constructs a new exception with the specified detail message, cause, suppression enabled or disabled, and
  93      * writable stack trace enabled or disabled.
  94      *
  95      * @param message
  96      *            the detail message.
  97      * @param cause
  98      *            the cause. (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
  99      * @param enableSuppression
 100      *            whether or not suppression is enabled or disabled
 101      * @param writableStackTrace
 102      *            whether or not the stack trace should be writable
 103      */
 104     public APPCException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
 105         super(message, cause, enableSuppression, writableStackTrace);
 106     }
 107
 108 }