Configuration


1   /* ========================================================================
2    * JCommon : a free general purpose class library for the Java(tm) platform
3    * ========================================================================
4    *
5    * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
6    * 
7    * Project Info:  http://www.jfree.org/jcommon/index.html
8    *
9    * This library is free software; you can redistribute it and/or modify it 
10   * under the terms of the GNU Lesser General Public License as published by 
11   * the Free Software Foundation; either version 2.1 of the License, or 
12   * (at your option) any later version.
13   *
14   * This library is distributed in the hope that it will be useful, but 
15   * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
16   * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
17   * License for more details.
18   *
19   * You should have received a copy of the GNU Lesser General Public
20   * License along with this library; if not, write to the Free Software
21   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
22   * USA.  
23   *
24   * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
25   * in the United States and other countries.]
26   * 
27   * ------------------
28   * Configuration.java
29   * ------------------
30   * (C)opyright 2002-2005, by Thomas Morgner and Contributors.
31   *
32   * Original Author:  Thomas Morgner (taquera@sherito.org);
33   * Contributor(s):   David Gilbert (for Object Refinery Limited);
34   *
35   * $Id: Configuration.java,v 1.7 2006/11/20 21:36:30 taqua Exp $
36   *
37   * Changes
38   * -------
39   * 02-May-2003 : Initial version (TM);
40   * 
41   */
42  
43  package org.jfree.util;
44  
45  import java.io.Serializable  ;
46  import java.util.Iterator  ;
47  import java.util.Enumeration  ;
48  
49  /**
50   * A simple query interface for a configuration.
51   *
52   * @author Thomas Morgner
53   */
54  public interface Configuration extends Serializable  , Cloneable   {
55  
56      /**
57       * Returns the configuration property with the specified key.
58       *
59       * @param key  the property key.
60       *
61       * @return the property value.
62       */
63      public String   getConfigProperty(String   key);
64  
65      /**
66       * Returns the configuration property with the specified key (or the 
67       * specified default value if there is no such property).
68       * <p>
69       * If the property is not defined in this configuration, the code will 
70       * lookup the property in the parent configuration.
71       *
72       * @param key  the property key.
73       * @param defaultValue  the default value.
74       *
75       * @return the property value.
76       */
77      public String   getConfigProperty(String   key, String   defaultValue);
78  
79      /**
80       * Returns all keys with the given prefix.
81       *
82       * @param prefix the prefix
83       * @return the iterator containing all keys with that prefix
84       */
85      public Iterator   findPropertyKeys(String   prefix);
86  
87      /**
88       * Returns the configuration properties.
89       * 
90       * @return The configuration properties.
91       */
92      public Enumeration   getConfigProperties();
93    
94      /**
95       * Returns a clone of the object.
96       *
97       * @return A clone.
98       *
99       * @throws CloneNotSupportedException if cloning is not supported for some reason.
100      */
101     public Object   clone() throws CloneNotSupportedException  ;
102 
103 }
104
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags