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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
/*
* ============LICENSE_START=======================================================
* ONAP Policy Engine - Common Modules
* ================================================================================
* Copyright (C) 2018 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.
* ============LICENSE_END=========================================================
*/
package org.onap.policy.common.utils.properties.exception;
/**
* Exception associated with a Property.
*/
public class PropertyException extends Exception {
private static final long serialVersionUID = 1L;
/**
* Name of the property for which the exception was thrown.
*/
private final String propertyName;
/**
* Name of the field for which the exception was thrown.
*/
private final String fieldName;
/**
* Constructor.
*
* @param propName name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
*/
public PropertyException(String propName, String fieldName) {
super(makeMessage(propName, fieldName));
this.propertyName = propName;
this.fieldName = fieldName;
}
/**
* Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
* @param message error message
*/
public PropertyException(String propnm, String fieldName, String message) {
super(makeMessage(propnm, fieldName, message));
this.propertyName = propnm;
this.fieldName = fieldName;
}
/**
* Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
* @param cause cause of the exception
*/
public PropertyException(String propnm, String fieldName, Throwable cause) {
super(makeMessage(propnm, fieldName), cause);
this.propertyName = propnm;
this.fieldName = fieldName;
}
/**
* Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
* @param message error message
* @param cause cause of the exception
*/
public PropertyException(String propnm, String fieldName, String message, Throwable cause) {
super(makeMessage(propnm, fieldName, message), cause);
this.propertyName = propnm;
this.fieldName = fieldName;
}
/**
* Get the property name.
*
* @return name of the property for which the exception was thrown, or {@code null} if
* no name was provided
*/
public String getPropertyName() {
return propertyName;
}
/**
* Get the field name.
*
* @return name of the field for which the exception was thrown, or {@code null} if no
* field was provided
*/
public String getFieldName() {
return fieldName;
}
/**
* Make the message.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
* @param message error message, never {@code null}
* @return an error message composed of the three items
*/
private static String makeMessage(String propnm, String fieldName, String message) {
return makeMessage(propnm, fieldName) + ": " + message;
}
/**
* Make the message.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
* @return an error message composed of the two items
*/
private static String makeMessage(String propnm, String fieldName) {
StringBuilder bldr = new StringBuilder(50);
if (propnm == null) {
bldr.append("property exception");
} else {
bldr.append("exception for property " + propnm);
}
if (fieldName != null) {
bldr.append(" with field " + fieldName);
}
return bldr.toString();
}
}
|
