f3db3ae60a57e3669389d806cf042d814125d8ff
[policy/apex-pdp.git] /
1 /*
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
4  * ================================================================================
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  * 
9  *      http://www.apache.org/licenses/LICENSE-2.0
10  * 
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  * 
17  * SPDX-License-Identifier: Apache-2.0
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.onap.policy.apex.model.basicmodel.concepts;
22
23 /**
24  * This class is a base run time exception from which all Apex run time exceptions are sub classes.
25  *
26  * @author Liam Fallon (liam.fallon@ericsson.com)
27  */
28 public class ApexRuntimeException extends RuntimeException {
29     private static final long serialVersionUID = -8507246953751956974L;
30
31     // The object on which the exception was thrown
32     private transient Object object = null;
33
34     /**
35      * Instantiates a new apex runtime exception.
36      *
37      * @param message the message on the exception
38      */
39     public ApexRuntimeException(final String message) {
40         super(message);
41     }
42
43     /**
44      * Instantiates a new apex runtime exception.
45      *
46      * @param message the message on the exception
47      * @param object the object that the exception was thrown on
48      */
49     public ApexRuntimeException(final String message, final Object object) {
50         super(message);
51         this.object = object;
52     }
53
54     /**
55      * Instantiates a new apex runtime exception.
56      *
57      * @param message the message on the exception
58      * @param e the exception that caused this Apex exception
59      */
60     public ApexRuntimeException(final String message, final Exception e) {
61         super(message, e);
62     }
63
64     /**
65      * Instantiates a new apex runtime exception.
66      *
67      * @param message the message on the exception
68      * @param e the exception that caused this Apex exception
69      * @param object the object that the exception was thrown on
70      */
71     public ApexRuntimeException(final String message, final Exception e, final Object object) {
72         super(message, e);
73         this.object = object;
74     }
75
76     /**
77      * Get the message from this exception and its causes.
78      *
79      * @return the message of this exception and all the exceptions that caused this exception
80      */
81     public String getCascadedMessage() {
82         final StringBuilder builder = new StringBuilder();
83         builder.append(this.getMessage());
84
85         for (Throwable t = this; t != null; t = t.getCause()) {
86             builder.append("\ncaused by: ");
87             builder.append(t.getMessage());
88         }
89
90         return builder.toString();
91     }
92
93     /**
94      * Get the object on which the exception was thrown.
95      *
96      * @return The object
97      */
98     public Object getObject() {
99         return object;
100     }
101 }