Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.configuration
Class BaseConfiguration

    java.lang.Object
      org.apache.commons.configuration.AbstractConfiguration
          org.apache.commons.configuration.BaseConfiguration

All Implemented Interfaces:
  Configuration

Direct Known Subclasses:
  AbstractFileConfiguration

public class BaseConfiguration
extends AbstractConfiguration

Basic configuration classe. Stores the configuration data but does not provide any load or save functions. If you want to load your Configuration from a file use PropertiesConfiguration or XmlConfiguration. This class extends normal Java properties by adding the possibility to use the same key many times concatenating the value strings instead of overwriting them.

Version:
  $Id: BaseConfiguration.java,v 1.8 2004/07/05 09:54:17 ebourg Exp $
Author:
  Stefano Mazzocchi, Jon S. Stevens, Dave Bryson, Geir Magnusson Jr., Leon Messerschmidt, Kent Johnson, Daniel Rall, Ilkka Priha, Jason van Zyl, Martin Poeschl, Henning P. Schmiedehausen, Konstantin Shaposhnikov, Oliver Heger

Nested Class Summary

Nested classes inherited from class org.apache.commons.configuration.AbstractConfiguration
`AbstractConfiguration.PropertiesTokenizer`

Field Summary

Fields inherited from class org.apache.commons.configuration.AbstractConfiguration
`END_TOKEN, START_TOKEN`

Constructor Summary
`BaseConfiguration()` Empty constructor.

Method Summary
`protected void` | `addPropertyDirect(String key, Object obj)` Adds a key/value pair to the map.
`void` | `clearProperty(String key)` Clear a property in the configuration.
`boolean` | `containsKey(String key)` check if the configuration contains the key
`Iterator` | `getKeys()` Get the list of the keys contained in the configuration repository.
`protected Object` | `getPropertyDirect(String key)` Read property from underlying map.
`boolean` | `isEmpty()` Check if the configuration is empty

Methods inherited from class org.apache.commons.configuration.AbstractConfiguration
`addProperty, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getKeys, getList, getList, getLong, getLong, getLong, getProperties, getProperties, getProperty, getShort, getShort, getShort, getString, getString, getStringArray, getVector, getVector, interpolate, interpolateHelper, isThrowExceptionOnMissing, setDelimiter, setProperty, setThrowExceptionOnMissing, split, subset`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### BaseConfiguration

    public BaseConfiguration()

  Empty constructor. You must add all the values to this configuration.

Method Detail

### addPropertyDirect

    protected void addPropertyDirect(String key,
                                     Object obj)

  Adds a key/value pair to the map. This routine does no magic morphing. It ensures the keylist is maintained

  Specified by:
    `addPropertyDirect` in class `AbstractConfiguration`
  Parameters:
    `key` - key to use for mapping
    `obj` - object to store

### getPropertyDirect

    protected Object getPropertyDirect(String key)

  Read property from underlying map.

  Specified by:
    `getPropertyDirect` in class `AbstractConfiguration`
  Parameters:
    `key` - key to use for mapping
  Returns:
    object associated with the given configuration key.

### isEmpty

    public boolean isEmpty()

  Check if the configuration is empty

  Specified by:
    `isEmpty` in interface `Configuration`
  Specified by:
    `isEmpty` in class `AbstractConfiguration`
  Returns:
    `true` if Configuration is empty, `false` otherwise.

### containsKey

    public boolean containsKey(String key)

  check if the configuration contains the key

  Specified by:
    `containsKey` in interface `Configuration`
  Specified by:
    `containsKey` in class `AbstractConfiguration`
  Parameters:
    `key` - the configuration key
  Returns:
    `true` if Configuration contain given key, `false` otherwise.

### clearProperty

    public void clearProperty(String key)

  Clear a property in the configuration.

  Specified by:
    `clearProperty` in interface `Configuration`
  Specified by:
    `clearProperty` in class `AbstractConfiguration`
  Parameters:
    `key` - the key to remove along with corresponding value.

### getKeys

    public Iterator getKeys()

  Get the list of the keys contained in the configuration repository.

  Specified by:
    `getKeys` in interface `Configuration`
  Specified by:
    `getKeys` in class `AbstractConfiguration`
  Returns:
    An Iterator.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2004 The Apache Software Foundation. All Rights Reserved.