KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > junitx > util > XMLPropertyManager


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 org.jaxen.jdom.JDOMXPath;
58 import org.jdom.Document;
59 import org.jdom.Element;
60 import org.jdom.input.SAXBuilder;
61
62 import java.io.FileInputStream JavaDoc;
63 import java.util.List JavaDoc;
64
65 /**
66  * <p>The <code>XMLPropertyManager</code> class represents a persistent set of
67  * properties loaded from an XML property file.</p>
68  *
69  * <h4>Usage</h4>
70  * <p>The location of the property file loaded by the <code>XMLPropertyManager</code>
71  * class is defined by the <code>XMLPropertyManager.file</code> JVM environment
72  * variable. For example, to initialize the <code>XMLPropertyManager</code>
73  * with a file located at <code>c:\project\props.xml</code>:</p>
74  *
75  * <pre>
76  * java -DXMLPropertyManager.file=c:\project\props.xml junit.textui.TestRunner AllTests
77  * </pre>
78  *
79  * <h4>Format of the file</h4>
80  * <pre>
81  * &lt;?xml version="1.0"?>
82  * &lt;properties>
83  * &lt;property name="propname" value="propvalue" />
84  * &lt;/properties>
85  * </pre>
86  *
87  * <h4>Notes</h4>
88  * <ul>
89  * <li>Nested properties are not supported</li>
90  * </ul>
91  *
92  * <h4>Required libraries</h4>
93  * <ul>
94  * <li>jdom.jar (available at <a HREF="http://jdom.org">jdom.org</a>)</li>
95  * <li>jaxen.jar (available at <a HREF="http://jaxen.org">jaxen.org</a>)</li>
96  * <li>saxpath.jar (available at <a HREF="http://saxpath.org">saxpath.org</a>)</li>
97  * <li>xercesImpl.jar [ requires also xmlParserAPIs.jar as of Xerces version 2.1.0 ] (available at <a HREF="http://xml.apache.org">xml.apache.org</a>)</li>
98  * </ul>
99  *
100  * @version $Revision: 1.4 $ $Date: 2003/02/06 20:43:55 $
101  * @author <a HREF="mailto:vbossica@users.sourceforge.net">Vladimir R. Bossicard</a>
102  */

103 public class XMLPropertyManager {
104
105     private static Document props;
106
107     static {
108         try {
109             String JavaDoc filename = System.getProperty("XMLPropertyManager.file");
110             FileInputStream JavaDoc is = new FileInputStream JavaDoc(filename);
111             props = new SAXBuilder(false).build(is);
112         } catch (Exception JavaDoc e) {
113             e.printStackTrace(System.err);
114         }
115     }
116
117     /**
118      * Don't let anyone instantiate this class
119      */

120     private XMLPropertyManager() {
121     }
122
123     /**
124      * Searches for the property with the specified key in this property list.
125      * The method returns <code>null</code> if the property is not found.
126      *
127      * @param key the hashtable key.
128      * @return the value in this property list with the specified key value.
129      * @see #getProperty(String, String)
130      */

131     public static String JavaDoc getProperty(String JavaDoc key) {
132         return getProperty(key, null);
133     }
134
135     /**
136      * Searches for the property with the specified key in this property list.
137      * The method returns the default value argument if the property is not
138      * found.
139      *
140      * @param key the hashtable key.
141      * @param defaultValue a default value.
142      * @return the value in this property list with the specified key value.
143      */

144     public static String JavaDoc getProperty(String JavaDoc key,
145                                      String JavaDoc defaultValue) {
146         if (props == null) {
147             return null;
148         }
149
150         String JavaDoc value = null;
151         try {
152             JDOMXPath path = new JDOMXPath("/properties/property[@name = \"" + key + "\"]");
153             List JavaDoc res = path.selectNodes(props);
154             if (res != null && res.size() != 0) {
155                 value = ((Element) res.get(0)).getAttribute("value").getValue();
156             }
157         } catch (Exception JavaDoc e) {
158             e.printStackTrace(System.err);
159         }
160         return value == null ? defaultValue : value;
161     }
162
163 }
164
Popular Tags