KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > discovery > tools > PropertiesHolder


1 /*
2  * $Header$
3  * $Revision$
4  * $Date$
5  *
6  * ====================================================================
7  *
8  * The Apache Software License, Version 1.1
9  *
10  * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
11  * reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  *
17  * 1. Redistributions of source code must retain the above copyright
18  * notice, this list of conditions and the following disclaimer.
19  *
20  * 2. Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in
22  * the documentation and/or other materials provided with the
23  * distribution.
24  *
25  * 3. The end-user documentation included with the redistribution, if
26  * any, must include the following acknowlegement:
27  * "This product includes software developed by the
28  * Apache Software Foundation (http://www.apache.org/)."
29  * Alternately, this acknowlegement may appear in the software itself,
30  * if and wherever such third-party acknowlegements normally appear.
31  *
32  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33  * Foundation" must not be used to endorse or promote products derived
34  * from this software without prior written permission. For written
35  * permission, please contact apache@apache.org.
36  *
37  * 5. Products derived from this software may not be called "Apache"
38  * nor may "Apache" appear in their names without prior written
39  * permission of the Apache Group.
40  *
41  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52  * SUCH DAMAGE.
53  * ====================================================================
54  *
55  * This software consists of voluntary contributions made by many
56  * individuals on behalf of the Apache Software Foundation. For more
57  * information on the Apache Software Foundation, please see
58  * <http://www.apache.org/>.
59  *
60  */
61
62 package org.apache.commons.discovery.tools;
63
64 import java.util.Properties JavaDoc;
65
66 import org.apache.commons.discovery.resource.ClassLoaders;
67
68
69 /**
70  * Holder for a default class.
71  *
72  * Class may be specified by name (String) or class (Class).
73  * Using the holder complicates the users job, but minimized # of API's.
74  *
75  * @author Richard A. Sitze
76  */
77 public class PropertiesHolder {
78     private Properties JavaDoc properties;
79     private final String JavaDoc propertiesFileName;
80     
81     public PropertiesHolder(Properties JavaDoc properties) {
82         this.properties = properties;
83         this.propertiesFileName = null;
84     }
85     
86     public PropertiesHolder(String JavaDoc propertiesFileName) {
87         this.properties = null;
88         this.propertiesFileName = propertiesFileName;
89     }
90
91     /**
92      * @param spi Optional SPI (may be null).
93      * If provided, an attempt is made to load the
94      * property file as-per Class.getResource().
95      *
96      * @param loaders Used only if properties need to be loaded.
97      *
98      * @return Properties. Load the properties if necessary.
99      */
100     public Properties JavaDoc getProperties(SPInterface spi, ClassLoaders loaders) {
101         if (properties == null) {
102             properties = ResourceUtils.loadProperties(spi.getSPClass(), getPropertiesFileName(), loaders);
103         }
104         return properties;
105     }
106
107     public String JavaDoc getPropertiesFileName() {
108         return propertiesFileName;
109     }
110 }
111
Popular Tags