org.apache.commons.configuration
Class MapConfiguration

java.lang.Object
  extended byorg.apache.commons.configuration.AbstractConfiguration
      extended byorg.apache.commons.configuration.MapConfiguration
All Implemented Interfaces:
Configuration
Direct Known Subclasses:
SystemConfiguration

public class MapConfiguration
extends AbstractConfiguration

A Map based Configuration.

Since:
1.1
Version:
$Revision$, $Date: 2005-02-26 13:56:39 +0100 (Sat, 26 Feb 2005) $
Author:
Emmanuel Bourg

Field Summary
protected  Map map
          The Map decorated by this configuration.
 
Fields inherited from class org.apache.commons.configuration.AbstractConfiguration
END_TOKEN, START_TOKEN
 
Constructor Summary
MapConfiguration(Map map)
          Create a Configuration decorator around the specified Map.
 
Method Summary
protected  void addPropertyDirect(String key, Object obj)
          Adds a key/value pair to the Configuration.
 void clearProperty(String key)
          Remove a property from the configuration.
 boolean containsKey(String key)
          Check if the configuration contains the specified key.
 Iterator getKeys()
          Get the list of the keys contained in the configuration.
 Map getMap()
          Return the Map decorated by this configuration.
 Object getProperty(String key)
          Gets a property from the configuration.
 boolean isEmpty()
          Check if the configuration is empty.
 
Methods inherited from class org.apache.commons.configuration.AbstractConfiguration
addProperty, clear, 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, getShort, getShort, getShort, getString, getString, getStringArray, interpolate, interpolateHelper, isThrowExceptionOnMissing, resolveContainerStore, setDelimiter, setProperty, setThrowExceptionOnMissing, subset
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

map

protected Map map
The Map decorated by this configuration.

Constructor Detail

MapConfiguration

public MapConfiguration(Map map)
Create a Configuration decorator around the specified Map. The map is used to store the configuration properties, any change will also affect the Map.

Parameters:
map -
Method Detail

getMap

public Map getMap()
Return the Map decorated by this configuration.


getProperty

public Object getProperty(String key)
Description copied from interface: Configuration
Gets a property from the configuration.

Parameters:
key - property to retrieve
Returns:
the value to which this configuration maps the specified key, or null if the configuration contains no mapping for this key.

addPropertyDirect

protected void addPropertyDirect(String key,
                                 Object obj)
Description copied from class: AbstractConfiguration
Adds a key/value pair to the Configuration. Override this method to provide write acces to underlying Configuration store.

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

isEmpty

public boolean isEmpty()
Description copied from class: AbstractConfiguration
Check if the configuration is empty.

Specified by:
isEmpty in interface Configuration
Specified by:
isEmpty in class AbstractConfiguration

containsKey

public boolean containsKey(String key)
Description copied from class: AbstractConfiguration
Check if the configuration contains the specified key.

Specified by:
containsKey in interface Configuration
Specified by:
containsKey in class AbstractConfiguration

clearProperty

public void clearProperty(String key)
Description copied from class: AbstractConfiguration
Remove a property from the configuration.

Specified by:
clearProperty in interface Configuration
Specified by:
clearProperty in class AbstractConfiguration

getKeys

public Iterator getKeys()
Description copied from class: AbstractConfiguration
Get the list of the keys contained in the configuration.

Specified by:
getKeys in interface Configuration
Specified by:
getKeys in class AbstractConfiguration


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