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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2019 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 java.lang.reflect.Field;
import java.util.Map;
import java.util.Map.Entry;
/**
* This class holds the result of the validation of a map of parameter groups.
*/
public class GroupMapValidationResult extends CommonGroupValidationResult {
// The name of the parameter group map
final String mapParameterName;
/**
* Constructor, create the group map validation result.
*
* @param field the map parameter field
* @param mapObject the value of the map parameter field
*/
protected GroupMapValidationResult(final Field field, final Object mapObject) {
super(ParameterConstants.PARAMETER_GROUP_MAP_HAS_STATUS_MESSAGE);
this.mapParameterName = field.getName();
// Cast the map object to a map of parameter groups keyed by string, we can't type check maps
// due to restrictions on generics so we have to check each entry key is a string and each entry
// value is a parameter group
@SuppressWarnings("unchecked")
Map<String, ParameterGroup> parameterGroupMap = (Map<String, ParameterGroup>) mapObject;
// Add a validation result per map entry
for (Entry<String, ParameterGroup> parameterGroupMapEntry : parameterGroupMap.entrySet()) {
// Create a validation status entry for the map
validationResultMap.put(parameterGroupMapEntry.getKey(),
new GroupValidationResult(parameterGroupMapEntry.getValue()));
}
}
/**
* Gets the name of the parameter being validated.
*
* @return the name
*/
@Override
public String getName() {
return mapParameterName;
}
/**
* Set the validation result on a parameter map entry.
*
* @param entryName The name of the parameter map entry
* @param status The validation status for the entry
* @param message The validation message for the entry
*/
public void setResult(final String entryName, final ValidationStatus status, final String message) {
ValidationResult validationResult = validationResultMap.get(entryName);
if (validationResult == null) {
throw new ParameterRuntimeException("no entry with name \"" + entryName + "\" exists");
}
// Set the status of the parameter group and replace the field result
validationResult.setResult(status, message);
this.setResult(status);
}
/**
* Set the validation result on a parameter map entry.
*
* @param entryName The name of the parameter map entry
* @param mapEntryValidationResult The validation result for the entry
*/
public void setResult(final String entryName, final ValidationResult mapEntryValidationResult) {
ValidationResult validationResult = validationResultMap.get(entryName);
if (validationResult == null) {
throw new ParameterRuntimeException("no entry with name \"" + entryName + "\" exists");
}
// Set the status of the parameter group and replace the field result
validationResultMap.put(entryName, mapEntryValidationResult);
this.setResult(mapEntryValidationResult.getStatus());
}
@Override
protected void addGroupTypeName(StringBuilder result) {
result.append("parameter group map \"");
result.append(mapParameterName);
result.append("\" ");
}
}
|
