|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.configuration.event.EventSource
org.apache.commons.configuration.AbstractConfiguration
org.apache.commons.configuration.EnvironmentConfiguration
public class EnvironmentConfiguration
A Configuration implementation that reads the platform specific environment
variables. On pre java5 JRE it uses Ant Execute task to read the environment.
(in this case ant must be present in classpath). On java >= 5 JRE it uses
java.lang.System#getenv()
and ant is not required.
This configuration implementation is read-only. It allows read access to the defined OS environment variables, but their values cannot be changed.
Usage of this class is easy: After an instance has been created the get
methods provided by the Configuration
interface can be used
for querying environment variables, e.g.:
Configuration envConfig = new EnvironmentConfiguration(); System.out.println("JAVA_HOME=" + envConfig.getString("JAVA_HOME");
Execute.getProcEnvironment()
Field Summary | |
---|---|
private java.util.Map |
environment
Stores the environment properties. |
private static java.lang.String |
METHOD_NAME
Constant for the name of the getenv() method. |
private static int |
VERSION_1_5
Constant for the Java version 1.5. |
Fields inherited from class org.apache.commons.configuration.AbstractConfiguration |
---|
END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_READ_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN |
Constructor Summary | |
---|---|
EnvironmentConfiguration()
Constructor. |
Method Summary | |
---|---|
protected void |
addPropertyDirect(java.lang.String key,
java.lang.Object value)
Adds a property to this configuration. |
void |
clear()
Removes all properties from this configuration. |
void |
clearProperty(java.lang.String key)
Removes a property from this configuration. |
boolean |
containsKey(java.lang.String key)
Check if the configuration contains the specified key. |
(package private) void |
extractProperties14()
Extracts environment properties on a JRE < 1.5. |
(package private) void |
extractProperties15()
Extracts environment properties on a JR >= 1.5. |
(package private) void |
extractPropertiesFromCollection(java.util.Collection env)
An internally used method for processing a collection with environment entries. |
java.util.Iterator |
getKeys()
Get the list of the keys contained in the configuration. |
java.lang.Object |
getProperty(java.lang.String key)
Gets a property from the configuration. |
boolean |
isEmpty()
Check if the configuration is empty. |
Methods inherited from class org.apache.commons.configuration.event.EventSource |
---|
addConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, clone, createErrorEvent, createEvent, fireError, fireEvent, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEvents |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final java.lang.String METHOD_NAME
private static final int VERSION_1_5
private java.util.Map environment
Constructor Detail |
---|
public EnvironmentConfiguration()
Method Detail |
---|
protected void addPropertyDirect(java.lang.String key, java.lang.Object value)
addPropertyDirect
in class AbstractConfiguration
key
- the key of the property to be addedvalue
- the property valuepublic boolean containsKey(java.lang.String key)
key
- the key whose presence in this configuration is to be tested
true
if the configuration contains a value for this
key, false
otherwiseConfiguration.containsKey(java.lang.String)
public java.util.Iterator getKeys()
remove()
method is specific to
a concrete implementation. It may remove the corresponding
property from the configuration, but this is not guaranteed. In any case
it is no replacement for calling
Configuration.clearProperty(String)
for this property. So it is
highly recommended to avoid using the iterator's remove()
method.
Configuration.getKeys()
public java.lang.Object getProperty(java.lang.String key)
Configuration
interface the other get methods (that
return specific data types) will internally make use of this method. On
this level variable substitution is not yet performed. The returned
object is an internal representation of the property value for the passed
in key. It is owned by the Configuration
object. So a caller
should not modify this object. It cannot be guaranteed that this object
will stay constant over time (i.e. further update operations on the
configuration may change its internal state).
key
- property to retrieve
Configuration.getProperty(java.lang.String)
public boolean isEmpty()
true
if the configuration contains no property,
false
otherwise.Configuration.isEmpty()
public void clearProperty(java.lang.String key)
clearProperty
in interface Configuration
clearProperty
in class AbstractConfiguration
key
- the key of the property to be removedpublic void clear()
clear
in interface Configuration
clear
in class AbstractConfiguration
void extractProperties14()
void extractPropertiesFromCollection(java.util.Collection env)
property=value
. Such a collection is returned by ant.
env
- the collection with the propertiesvoid extractProperties15()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |