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
|
/*
* ============LICENSE_START=======================================================
* 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 lombok.Getter;
/**
* Basic implementation of a ValidationResult.
*/
@Getter
public abstract class ValidationResultImpl implements ValidationResult {
public static final String ITEM_HAS_STATUS_MESSAGE = "item has status ";
/**
* Name of the object of this result.
*/
private final String name;
/**
* Object being validated.
*/
private final Object object;
/**
* Validation status of this object.
*/
private ValidationStatus status = ValidationStatus.CLEAN;
/**
* Validation message.
*/
private String message = ITEM_HAS_STATUS_MESSAGE + status.toString();
/**
* Constructs the object.
*
* @param name name of the object of this result
* @param object object being validated
*/
public ValidationResultImpl(String name, Object object) {
this.name = name;
this.object = object;
}
/**
* Constructs the object.
*
* @param name name of the object of this result
* @param object object being validated
* @param status the validation status
* @param message the validation message explaining the validation status
*/
public ValidationResultImpl(String name, Object object, ValidationStatus status, String message) {
this.name = name;
this.object = object;
this.status = status;
this.message = message;
}
/**
* Validates that the value is not {@code null}.
*
* @return {@code true} if the value is not null, {@code false} otherwise
*/
public boolean validateNotNull() {
if (object == null) {
setResult(ValidationStatus.INVALID, "is null");
return false;
} else {
return true;
}
}
/**
* Set the validation result status. On a sequence of calls, the most serious
* validation status is recorded, assuming the status enum ordinals increase in order
* of severity.
*
* @param status validation status the bean is receiving
*/
public void setResult(final ValidationStatus status) {
setResult(status, ITEM_HAS_STATUS_MESSAGE + status.toString());
}
/**
* Set the validation result status. On a sequence of calls, the most serious
* validation status is recorded, assuming the status enum ordinals increase in order
* of severity.
*
* @param status the validation status
* @param message the validation message explaining the validation status
*/
@Override
public void setResult(final ValidationStatus status, final String message) {
if (this.status.ordinal() < status.ordinal()) {
this.status = status;
this.message = message;
}
}
}
|