001 /* This file is part of the project "Hilbert II" - http://www.qedeq.org
002 *
003 * Copyright 2000-2011, Michael Meyling <mime@qedeq.org>.
004 *
005 * "Hilbert II" is free software; you can redistribute
006 * it and/or modify it under the terms of the GNU General Public
007 * License as published by the Free Software Foundation; either
008 * version 2 of the License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
013 * GNU General Public License for more details.
014 */
015
016 package org.qedeq.kernel.se.config;
017
018 import java.io.File;
019 import java.io.FileInputStream;
020 import java.io.FileOutputStream;
021 import java.io.IOException;
022 import java.io.InputStream;
023 import java.io.OutputStream;
024 import java.util.ArrayList;
025 import java.util.Collections;
026 import java.util.Enumeration;
027 import java.util.HashMap;
028 import java.util.Iterator;
029 import java.util.List;
030 import java.util.Map;
031 import java.util.Properties;
032
033 import org.qedeq.base.io.IoUtility;
034
035
036 /**
037 * This class reads entries from property files. This class should not
038 * be used outside this package.
039 *
040 * @author Michael Meyling
041 */
042 final class ConfigAccess {
043
044 /** Config file. */
045 private final File configFile;
046
047 /** Collector for properties. */
048 private Properties properties = new Properties();
049
050 /** Config file description. */
051 private final String description;
052
053 /**
054 * Get access for a config file.
055 *
056 * @param configFile Config file.
057 * @param description Config file description
058 * @throws IOException Config file couldn't be loaded.
059 */
060 public ConfigAccess(final File configFile, final String description) throws IOException {
061 this.configFile = configFile;
062 this.description = description;
063 FileInputStream stream = null;
064 try {
065 stream = new FileInputStream(configFile);
066 load(stream);
067 } catch (IOException e) {
068 System.out.println("no config file found, using default values");
069 } finally {
070 IoUtility.close(stream);
071 }
072 setString("configFileLocation", configFile.getCanonicalPath());
073 }
074
075 /**
076 * Get config file.
077 *
078 * @return Config file.
079 */
080 public final File getConfigFile() {
081 return configFile;
082 }
083
084 /**
085 * Get description for config file.
086 *
087 * @return Config file description.
088 */
089 public final String getConfigDescription() {
090 return description;
091 }
092
093 /**
094 * Get properties.
095 *
096 * @return properties.
097 */
098 private final Properties getProperties() {
099 return properties;
100 }
101
102 /**
103 * Load properties from stream. The properties are
104 * added to the previous ones.
105 *
106 * @param inStream load from this stream
107 * @throws IOException loading failed
108 */
109 private final void load(final InputStream inStream) throws IOException {
110 getProperties().load(inStream);
111 }
112
113 /**
114 * Store properties in config file.
115 *
116 * @throws IOException Saving failed.
117 */
118 public final void store() throws IOException {
119 OutputStream out = null;
120 try {
121 out = new FileOutputStream(getConfigFile());
122 getProperties().store(out, getConfigDescription());
123 } finally {
124 if (out != null) {
125 try {
126 out.close();
127 } catch (IOException e) {
128 throw e;
129 } catch (Exception e) {
130 throw new IOException(e.toString());
131 }
132 }
133 }
134 }
135
136 /**
137 * Return String property.
138 *
139 * @param name Get this property.
140 * @return String for looked property. <code>null</code>, if property is missing.
141 */
142 public final String getString(final String name) {
143 return getProperties().getProperty(name);
144 }
145
146 /**
147 * Return String property.
148 *
149 * @param name Look for this String property.
150 * @param defaultValue Return this value if property doesn't exist.
151 * @return Value of property. Equal to default value if parameter doesn't exist.
152 */
153 public final String getString(final String name, final String defaultValue) {
154 final String value = getProperties().getProperty(name);
155 if (value == null) {
156 setString(name, defaultValue);
157 return defaultValue;
158 } else {
159 return value;
160 }
161 }
162
163 /**
164 * Set String property.
165 *
166 * @param name Set this property.
167 * @param value Set property to this value.
168 */
169 public final void setString(final String name, final String value) {
170 getProperties().setProperty(name, value);
171 }
172
173 /**
174 * Get list of String properties with certain prefix.
175 * Example:
176 * <ul>
177 * <li>qeq=green</li>
178 * <li>module2=tiger</li>
179 * <li>module3=tulip</li>
180 * <li>modula=green</li>
181 * <li>module1=bluebird</li>
182 * </ul>
183 * If namePrefix == "module" we get:
184 * <ul>
185 * <li>module1=bluebird</li>
186 * <li>module2=tiger</li>
187 * <li>module3=tulip</li>
188 * </ul>
189 * The sequence of resulting properties is sorted by their keys.
190 *
191 * @param namePrefix Prefix of seek property name.
192 * @return List of key sorted string properties (maybe empty).
193 */
194 public final String[] getStringProperties(final String namePrefix) {
195 final List list = new ArrayList();
196 final Enumeration keys = getProperties().keys();
197 final List keyList = Collections.list(keys);
198 Collections.sort(keyList);
199 for (int i = 0; i < keyList.size(); i++) {
200 final String key = (String) keyList.get(i);
201 if (key.startsWith(namePrefix)) {
202 list.add(getProperties().get(key));
203 }
204 }
205 return (String []) list.toArray(new String[list.size()]);
206 }
207
208 /**
209 * Get map of String properties with certain prefix.
210 *
211 * @param namePrefix Prefix of seek property name.
212 * @return Map of properties that have String keys that start with <code>namePrefix</code>.
213 * The prefix is removed of for the resulting map.
214 */
215 public final Map getProperties(final String namePrefix) {
216 final Map result = new HashMap();
217 Iterator i = getProperties().entrySet().iterator();
218 while (i.hasNext()) {
219 Map.Entry entry = (Map.Entry) i.next();
220 final String name = String.valueOf(entry.getKey());
221 if (name.startsWith(namePrefix)) {
222 result.put(name.substring(namePrefix.length()), entry.getValue());
223 }
224 }
225 return result;
226 }
227
228 /**
229 * Set int property.
230 *
231 * @param name Set this property.
232 * @param value Set property to this value.
233 */
234 public final void setInteger(final String name, final int value) {
235 setString(name, "" + value);
236 }
237
238
239 /**
240 * Get int property.
241 *
242 * @param name look for this property
243 * @return property
244 * @throws IllegalArgumentException Property is no valid int value
245 * @throws NullPointerException Property doesn't exist
246 */
247 public final int getInteger(final String name) {
248 final String intPropAsString = getProperties().getProperty(name);
249 if (intPropAsString != null) {
250 try {
251 return Integer.parseInt(intPropAsString);
252 } catch (NumberFormatException ex) {
253 throw new IllegalArgumentException(
254 "int property " + intPropAsString + " has invalid format");
255 }
256 } else {
257 throw new NullPointerException("property \"" + name + "\" not found");
258 }
259 }
260
261 /**
262 * Return int property.
263 *
264 * @param name Look for this integer property.
265 * @param defaultValue Return this value if property doesn't exist.
266 * @return int value of property. Equal to default value if parameter doesn't exist.
267 * @throws IllegalArgumentException Property is no valid int value.
268 */
269 public final int getInteger(final String name, final int defaultValue) {
270 final String intPropAsString = getProperties().getProperty(name);
271 if (intPropAsString != null && intPropAsString.length() > 0) {
272 try {
273 return Integer.parseInt(intPropAsString);
274 } catch (NumberFormatException ex) {
275 throw new IllegalArgumentException(
276 "Integer-Property " + intPropAsString + " has invalid format");
277 }
278 } else {
279 setInteger(name, defaultValue);
280 return defaultValue;
281 }
282 }
283
284 /**
285 * Remove property.
286 *
287 * @param name Property to delete.
288 */
289 public final void removeProperty(final String name) {
290 getProperties().remove(name);
291 }
292
293 /**
294 * Remove properties with certain prefix.
295 *
296 * Example:
297 * <ul>
298 * <li>module1=bluebird</li>
299 * <li>module2=tiger</li>
300 * <li>module3=tulip</li>
301 * </ul>
302 * Calling with value <code>module</code> deletes all.
303 *
304 * @param namePrefix Prefix of seeked property name.
305 */
306 public final void removeProperties(final String namePrefix) {
307 final Enumeration keys = getProperties().keys();
308 while (keys.hasMoreElements()) {
309 final String key = (String) keys.nextElement();
310 if (key.startsWith(namePrefix)) {
311 getProperties().remove(key);
312 }
313 }
314 }
315
316 }
|