c3ecd2fd8d6a1dd88ab06a59bada64a99a339b47
[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 final transient Object object;
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         this.object = null;
42     }
43
44     /**
45      * Instantiates a new apex runtime exception.
46      *
47      * @param message the message on the exception
48      * @param object the object that the exception was thrown on
49      */
50     public ApexRuntimeException(final String message, final Object object) {
51         super(message);
52         this.object = object;
53     }
54
55     /**
56      * Instantiates a new apex runtime exception.
57      *
58      * @param message the message on the exception
59      * @param e the exception that caused this Apex exception
60      */
61     public ApexRuntimeException(final String message, final Exception e) {
62         super(message, e);
63         this.object = null;
64     }
65
66     /**
67      * Instantiates a new apex runtime exception.
68      *
69      * @param message the message on the exception
70      * @param e the exception that caused this Apex exception
71      * @param object the object that the exception was thrown on
72      */
73     public ApexRuntimeException(final String message, final Exception e, final Object object) {
74         super(message, e);
75         this.object = object;
76     }
77
78     /**
79      * Get the message from this exception and its causes.
80      *
81      * @return the message of this exception and all the exceptions that caused this exception
82      */
83     public String getCascadedMessage() {
84         final StringBuilder builder = new StringBuilder();
85         builder.append(this.getMessage());
86
87         for (Throwable t = this; t != null; t = t.getCause()) {
88             builder.append("\ncaused by: ");
89             builder.append(t.getMessage());
90         }
91
92         return builder.toString();
93     }
94
95     /**
96      * Get the object on which the exception was thrown.
97      *
98      * @return The object
99      */
100     public Object getObject() {
101         return object;
102     }
103 }