summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/aai/validation/reader/data/AttributeValues.java
blob: 78665efc8a1f65ff9d84ba12f9b04b112fffa4c3 (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
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
/*
 * ============LICENSE_START===================================================
 * Copyright (c) 2018 Amdocs
 * ============================================================================
 * 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.aai.validation.reader.data;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Stores a collection of attribute values (retrievable by name).
 */
public class AttributeValues {

	private Map<String, Object> map;

	/**
	 * Instantiates a new empty set of attribute values.
	 */
	public AttributeValues() {
		this.map = new HashMap<>();
	}

	/**
	 * Instantiates a new set of attribute values using the provided properties map.
	 *
	 * @param map
	 *            the attribute name/value pairs
	 */
	public AttributeValues(Map<String, Object> map) {
		this.map = map;
	}

	/**
	 * Instantiates a new set of attribute values comprising one name/value pair.
	 *
	 * @param key
	 *            the attribute name
	 * @param value
	 *            the attribute value
	 */
	public AttributeValues(String key, String value) {
		this();
		this.map.put(key, value);
	}

	@Override
	public String toString() {
		return map.toString();
	}

	/**
	 *
	 * @return the number of attributes stored
	 */
	public int size() {
		return this.map.size();
	}

	/**
	 * Add an attribute name/value pair.
	 *
	 * @param key
	 *            the attribute name
	 * @param value
	 *            the attribute value
	 */
	public void put(String key, Object value) {
		this.map.put(key, value);
	}

	/**
	 * Add an attribute name with a collection of values.
	 *
	 * @param key
	 *            the attribute name
	 * @param valueList
	 *            the collection of attribute values
	 */
	public void put(String key, List<String> valueList) {
		this.map.put(key, valueList);
	}

	/**
	 * Removes the attribute
	 *
	 * @param key
	 *            the attribute name
	 */
	public void remove(String key) {
		this.map.remove(key);

	}

	/**
	 * Overwrites the attribute values, replacing them with the specified attribute to attribute values mappings
	 *
	 * @param map
	 *            the name/values to store
	 */
	public void setMap(Map<String, Object> map) {
		this.map = map;
	}

	/**
	 * Gets an attribute value
	 *
	 * @param attrName
	 *            the attribute name
	 * @return the object
	 */
	public Object get(String attrName) {
		return this.map.get(attrName);
	}

	/**
	 * Converts the attribute values into a report-friendly format
	 *
	 * @return a Map which is a copy of the AttributeValues, formatted for reporting
	 */
	public Map<String, Object> generateReport() {
		return map;
	}

}