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

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