aboutsummaryrefslogtreecommitdiffstats
path: root/common-parameters/src/main/java/org/onap/policy/common/parameters/ParameterException.java
blob: aa3105ef8047e01559f202b6630ede47b6e23c46 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.common.parameters;

import lombok.Getter;

/**
 * Exception thrown oon parameter reading, validation, and check errors.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class ParameterException extends Exception {
    private static final long serialVersionUID = -8507246953751956974L;

    // The object on which the exception was thrown
    @Getter
    private final transient Object object;

    /**
     * Instantiates a new parameter exception.
     *
     * @param message the message on the exception
     */
    public ParameterException(final String message) {
        this(message, null);
    }

    /**
     * Instantiates a new parameter exception.
     *
     * @param message the message on the exception
     * @param object the object that the exception was thrown on
     */
    public ParameterException(final String message, final Object object) {
        super(message);
        this.object = object;
    }

    /**
     * Instantiates a new parameter exception.
     *
     * @param message the message on the exception
     * @param exception the exception that caused this parameter exception
     */
    public ParameterException(final String message, final Exception exception) {
        this(message, exception, null);
    }

    /**
     * Instantiates a new parameter exception.
     *
     * @param message the message on the exception
     * @param exception the exception that caused this parameter exception
     * @param object the object that the exception was thrown on
     */
    public ParameterException(final String message, final Exception exception, final Object object) {
        super(message, exception);
        this.object = object;
    }

    /**
     * Get the message from this exception and its causes.
     *
     * @return the cascaded messages from this exception and the exceptions that caused it
     */
    public String getCascadedMessage() {
        return buildCascadedMessage(this);
    }

    /**
     * Build a cascaded message from an exception and all its nested exceptions.
     *
     * @param throwable the top level exception
     * @return cascaded message string
     */
    public static String buildCascadedMessage(final Throwable throwable) {
        final var builder = new StringBuilder();
        builder.append(throwable.getMessage());

        for (var t = throwable; t != null; t = t.getCause()) {
            builder.append("\ncaused by: ");
            builder.append(t.getMessage());
        }

        return builder.toString();
    }
}