Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
BaseConfiguration |
|
| 2.0;2 |
1 | /* | |
2 | * Licensed to the Apache Software Foundation (ASF) under one or more | |
3 | * contributor license agreements. See the NOTICE file distributed with | |
4 | * this work for additional information regarding copyright ownership. | |
5 | * The ASF licenses this file to You under the Apache License, Version 2.0 | |
6 | * (the "License"); you may not use this file except in compliance with | |
7 | * the License. You may obtain a copy of the License at | |
8 | * | |
9 | * http://www.apache.org/licenses/LICENSE-2.0 | |
10 | * | |
11 | * Unless required by applicable law or agreed to in writing, software | |
12 | * distributed under the License is distributed on an "AS IS" BASIS, | |
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
14 | * See the License for the specific language governing permissions and | |
15 | * limitations under the License. | |
16 | */ | |
17 | ||
18 | package org.apache.commons.configuration; | |
19 | ||
20 | import java.util.ArrayList; | |
21 | import java.util.Collection; | |
22 | import java.util.Iterator; | |
23 | import java.util.LinkedHashMap; | |
24 | import java.util.List; | |
25 | import java.util.Map; | |
26 | ||
27 | /** | |
28 | * Basic configuration class. Stores the configuration data but does not | |
29 | * provide any load or save functions. If you want to load your Configuration | |
30 | * from a file use PropertiesConfiguration or XmlConfiguration. | |
31 | * | |
32 | * This class extends normal Java properties by adding the possibility | |
33 | * to use the same key many times concatenating the value strings | |
34 | * instead of overwriting them. | |
35 | * | |
36 | * @author <a href="mailto:stefano@apache.org">Stefano Mazzocchi</a> | |
37 | * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a> | |
38 | * @author <a href="mailto:daveb@miceda-data">Dave Bryson</a> | |
39 | * @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> | |
40 | * @author <a href="mailto:leon@opticode.co.za">Leon Messerschmidt</a> | |
41 | * @author <a href="mailto:kjohnson@transparent.com">Kent Johnson</a> | |
42 | * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a> | |
43 | * @author <a href="mailto:ipriha@surfeu.fi">Ilkka Priha</a> | |
44 | * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> | |
45 | * @author <a href="mailto:mpoeschl@marmot.at">Martin Poeschl</a> | |
46 | * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a> | |
47 | * @author <a href="mailto:ksh@scand.com">Konstantin Shaposhnikov</a> | |
48 | * @version $Id: BaseConfiguration.java 1231721 2012-01-15 18:32:07Z oheger $ | |
49 | */ | |
50 | 2180 | public class BaseConfiguration extends AbstractConfiguration implements Cloneable |
51 | { | |
52 | /** stores the configuration key-value pairs */ | |
53 | 2180 | private Map<String, Object> store = new LinkedHashMap<String, Object>(); |
54 | ||
55 | /** | |
56 | * Adds a key/value pair to the map. This routine does no magic morphing. | |
57 | * It ensures the keylist is maintained | |
58 | * | |
59 | * @param key key to use for mapping | |
60 | * @param value object to store | |
61 | */ | |
62 | @Override | |
63 | protected void addPropertyDirect(String key, Object value) | |
64 | { | |
65 | 156312 | Object previousValue = getProperty(key); |
66 | ||
67 | 156312 | if (previousValue == null) |
68 | { | |
69 | 109936 | store.put(key, value); |
70 | } | |
71 | 46376 | else if (previousValue instanceof List) |
72 | { | |
73 | // safe to case because we have created the lists ourselves | |
74 | @SuppressWarnings("unchecked") | |
75 | 10743 | List<Object> valueList = (List<Object>) previousValue; |
76 | // the value is added to the existing list | |
77 | 10743 | valueList.add(value); |
78 | 10743 | } |
79 | else | |
80 | { | |
81 | // the previous value is replaced by a list containing the previous value and the new value | |
82 | 35633 | List<Object> list = new ArrayList<Object>(); |
83 | 35633 | list.add(previousValue); |
84 | 35633 | list.add(value); |
85 | ||
86 | 35633 | store.put(key, list); |
87 | } | |
88 | 156312 | } |
89 | ||
90 | /** | |
91 | * Read property from underlying map. | |
92 | * | |
93 | * @param key key to use for mapping | |
94 | * | |
95 | * @return object associated with the given configuration key. | |
96 | */ | |
97 | public Object getProperty(String key) | |
98 | { | |
99 | 165542 | return store.get(key); |
100 | } | |
101 | ||
102 | /** | |
103 | * Check if the configuration is empty | |
104 | * | |
105 | * @return {@code true} if Configuration is empty, | |
106 | * {@code false} otherwise. | |
107 | */ | |
108 | public boolean isEmpty() | |
109 | { | |
110 | 16 | return store.isEmpty(); |
111 | } | |
112 | ||
113 | /** | |
114 | * check if the configuration contains the key | |
115 | * | |
116 | * @param key the configuration key | |
117 | * | |
118 | * @return {@code true} if Configuration contain given key, | |
119 | * {@code false} otherwise. | |
120 | */ | |
121 | public boolean containsKey(String key) | |
122 | { | |
123 | 2702 | return store.containsKey(key); |
124 | } | |
125 | ||
126 | /** | |
127 | * Clear a property in the configuration. | |
128 | * | |
129 | * @param key the key to remove along with corresponding value. | |
130 | */ | |
131 | @Override | |
132 | protected void clearPropertyDirect(String key) | |
133 | { | |
134 | 1000 | if (containsKey(key)) |
135 | { | |
136 | 110 | store.remove(key); |
137 | } | |
138 | 1000 | } |
139 | ||
140 | @Override | |
141 | public void clear() | |
142 | { | |
143 | 1984 | fireEvent(EVENT_CLEAR, null, null, true); |
144 | 1984 | store.clear(); |
145 | 1984 | fireEvent(EVENT_CLEAR, null, null, false); |
146 | 1984 | } |
147 | ||
148 | /** | |
149 | * Get the list of the keys contained in the configuration | |
150 | * repository. | |
151 | * | |
152 | * @return An Iterator. | |
153 | */ | |
154 | public Iterator<String> getKeys() | |
155 | { | |
156 | 273 | return store.keySet().iterator(); |
157 | } | |
158 | ||
159 | /** | |
160 | * Creates a copy of this object. This implementation will create a deep | |
161 | * clone, i.e. the map that stores the properties is cloned, too. So changes | |
162 | * performed at the copy won't affect the original and vice versa. | |
163 | * | |
164 | * @return the copy | |
165 | * @since 1.3 | |
166 | */ | |
167 | @Override | |
168 | public Object clone() | |
169 | { | |
170 | try | |
171 | { | |
172 | 11 | BaseConfiguration copy = (BaseConfiguration) super.clone(); |
173 | // This is safe because the type of the map is known | |
174 | @SuppressWarnings("unchecked") | |
175 | 11 | Map<String, Object> clonedStore = (Map<String, Object>) ConfigurationUtils.clone(store); |
176 | 11 | copy.store = clonedStore; |
177 | ||
178 | // Handle collections in the map; they have to be cloned, too | |
179 | 11 | for (Map.Entry<String, Object> e : store.entrySet()) |
180 | { | |
181 | 67 | if (e.getValue() instanceof Collection) |
182 | { | |
183 | // This is safe because the collections were created by ourselves | |
184 | @SuppressWarnings("unchecked") | |
185 | 16 | Collection<String> strList = (Collection<String>) e.getValue(); |
186 | 16 | copy.store.put(e.getKey(), new ArrayList<String>(strList)); |
187 | 67 | } |
188 | } | |
189 | ||
190 | 11 | return copy; |
191 | } | |
192 | 0 | catch (CloneNotSupportedException cex) |
193 | { | |
194 | // should not happen | |
195 | 0 | throw new ConfigurationRuntimeException(cex); |
196 | } | |
197 | } | |
198 | } |