KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > junitx > util > PropertyManager


1 /*
2  * The JUnit-addons Software License, Version 1.0
3  * (based on the Apache Software License, Version 1.1)
4  *
5  * Copyright (c) 2002-2003 Vladimir R. Bossicard. All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if
20  * any, must include the following acknowlegement:
21  * "This product includes software developed by Vladimir R.
22  * Bossicard as well as other contributors
23  * (http://junit-addons.sourceforge.net/)."
24  * Alternately, this acknowlegement may appear in the software itself,
25  * if and wherever such third-party acknowlegements normally appear.
26  *
27  * 4. The name "JUnit-addons" must not be used to endorse or promote
28  * products derived from this software without prior written
29  * permission. For written permission, please contact
30  * vbossica@users.sourceforge.net.
31  *
32  * 5. Products derived from this software may not be called "JUnit-addons"
33  * nor may "JUnit-addons" appear in their names without prior written
34  * permission of the project managers.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ======================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals. For more information on the JUnit-addons Project, please
52  * see <http://junit-addons.sourceforge.net/>.
53  */
54
55 package junitx.util;
56
57 import java.io.FileInputStream JavaDoc;
58 import java.util.Properties JavaDoc;
59
60 /**
61  * <p>The <code>PropertyManager</code> class represents a persistent set of
62  * properties loaded from a standard Property file.</p>
63  *
64  * <h4>Usage</h4>
65  * <p>The location of the property file loaded by the <code>PropertyManager</code>
66  * class is defined by the <code>PropertyManager.file</code> JVM environment
67  * variable. For example, to initialize the <code>PropertyManager</code>
68  * with a file located at <code>c:\project\props.properties</code>:</p>
69  *
70  * <pre>
71  * java -DPropertyManager.file=c:\project\props.properties junit.textui.TestRunner AllTests
72  * </pre>
73  *
74  * <h4>Format of the file</h4>
75  * <pre>
76  * propname=propvalue
77  * </pre>
78  *
79  * @version $Revision: 1.4 $ $Date: 2003/03/23 01:25:24 $
80  * @author <a HREF="mailto:vbossica@users.sourceforge.net">Vladimir R. Bossicard</a>
81  */
82 public class PropertyManager {
83
84     private static Properties JavaDoc props;
85
86     static {
87         try {
88             props = new Properties JavaDoc();
89             props.load(new FileInputStream JavaDoc(System.getProperty("PropertyManager.file")));
90         } catch (Exception JavaDoc e) {
91             e.printStackTrace(System.err);
92         }
93     }
94
95     /**
96      * Don't let anyone instantiate this class
97      */
98     private PropertyManager() {
99     }
100
101     /**
102      * Maps the specified key to the specified value in this property list.
103      *
104      * @return the previous value of the specified key in this property list, or
105      * null if it did not have one.
106      * @param key the hashtable key.
107      * @param value a value.
108      */
109     public static Object JavaDoc setProperty(String JavaDoc key,
110                                        String JavaDoc value)
111             throws NullPointerException JavaDoc {
112         return props.setProperty(key, value);
113     }
114                                      
115     /**
116      * Searches for the property with the specified key in this property list.
117      * The method returns <code>null</code> if the property is not found.
118      *
119      * @param key the hashtable key.
120      * @return the value in this property list with the specified key value.
121      * @see #getProperty(String, String)
122      */
123     public static String JavaDoc getProperty(String JavaDoc key) {
124         return getProperty(key, null);
125     }
126
127     /**
128      * Searches for the property with the specified key in this property list.
129      * The method returns the default value argument if the property is not
130      * found.
131      *
132      * @param key the hashtable key.
133      * @param defaultValue a default value.
134      * @return the value in this property list with the specified key value.
135      */
136     public static String JavaDoc getProperty(String JavaDoc key,
137                                      String JavaDoc defaultValue) {
138         if (props == null) {
139             return null;
140         }
141         return props.getProperty(key, defaultValue);
142     }
143
144 }
145
Popular Tags