aboutsummaryrefslogtreecommitdiffstats
path: root/model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxValidationMessage.java
blob: 9e245c07bf05d56e7463d3fd29a69918697ef7da (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
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2019 Nordix Foundation.
 * ================================================================================
 * 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.apex.model.basicmodel.concepts;

import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
import org.onap.policy.common.utils.validation.Assertions;

/**
 * A validation message is created for each validation observation observed during validation of a concept. The message
 * holds the key and the class of the concept on which the observation was made as well as the type of observation and a
 * message describing the observation.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class AxValidationMessage {
    private final AxKey observedKey;
    private ValidationResult validationResult = ValidationResult.VALID;
    private final String observedClass;
    private final String message;

    /**
     * Create an validation observation with the given fields.
     *
     * @param observedKey the key of the class on which the validation observation was made
     * @param observedClass the class on which the validation observation was made
     * @param validationResult the type of observation made
     * @param message a message describing the observation
     */
    public AxValidationMessage(final AxKey observedKey, final Class<?> observedClass,
            final ValidationResult validationResult, final String message) {
        Assertions.argumentNotNull(observedKey, "observedKey may not be null");
        Assertions.argumentNotNull(observedClass, "observedClass may not be null");
        Assertions.argumentNotNull(validationResult, "validationResult may not be null");
        Assertions.argumentNotNull(message, "message may not be null");

        this.observedKey = observedKey;
        this.observedClass = observedClass.getName();
        this.validationResult = validationResult;
        this.message = message;
    }

    /**
     * Gets the key of the observation.
     *
     * @return the key of the observation
     */
    public AxKey getObservedKey() {
        return observedKey;
    }

    /**
     * Gets the observed class.
     *
     * @return the observed class
     */
    public String getObservedClass() {
        return observedClass;
    }

    /**
     * Gets the type of observation made.
     *
     * @return the type of observation made
     */
    public ValidationResult getValidationResult() {
        return validationResult;
    }

    /**
     * Get a description of the observation.
     *
     * @return the observation description
     */
    public String getMessage() {
        return message;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public String toString() {
        return observedKey.toString() + ':' + observedClass + ':' + validationResult.name() + ':' + message;
    }
}