aboutsummaryrefslogtreecommitdiffstats
path: root/common-parameters/src/main/java/org/onap/policy/common/parameters/EntryValidator.java
blob: 965c95e5177f0f1e3e749e5c38d29352a5a97c9a (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
/*-
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2020 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.parameters;

import java.lang.annotation.Annotation;
import java.util.Map;

/**
 * Validator of an entry within a Map.
 */
public class EntryValidator {
    private final ItemValidator keyValidator;
    private final ItemValidator valueValidator;

    /**
     * Constructs the object.
     *
     * @param validator provider of validation methods
     * @param keyAnnotationContainer an annotation containing validation annotations to be
     *        applied to the entry key
     * @param valueAnnotationContainer an annotation containing validation annotations to
     *        be applied to the entry value
     */
    public EntryValidator(BeanValidator validator, Annotation keyAnnotationContainer,
                    Annotation valueAnnotationContainer) {
        keyValidator = new ItemValidator(validator, keyAnnotationContainer);
        valueValidator = new ItemValidator(validator, valueAnnotationContainer);
    }

    public boolean isEmpty() {
        return (keyValidator.isEmpty() && valueValidator.isEmpty());
    }

    /**
     * Performs validation of a single entry.
     *
     * @param result validation results are added here
     * @param entry value to be validated
     */
    public <K, V> void validateEntry(BeanValidationResult result, Map.Entry<K, V> entry) {
        String name = getName(entry);

        BeanValidationResult result2 = new BeanValidationResult(name, entry);
        keyValidator.validateValue(result2, "key", entry.getKey());
        valueValidator.validateValue(result2, "value", entry.getValue());

        if (!result2.isClean()) {
            result.addResult(result2);
        }
    }

    /**
     * Gets a name for the entry.
     *
     * @param entry entry whose name is to be determined
     * @return a name for the entry
     */
    protected <K, V> String getName(Map.Entry<K, V> entry) {
        K key = entry.getKey();
        if (key == null) {
            return "";
        }

        return key.toString();
    }
}