public class SubsetConfiguration extends AbstractConfiguration
A subset of another configuration. The new Configuration object contains every key from the parent Configuration that starts with prefix. The prefix is removed from the keys in the subset.
It is usually not necessary to use this class directly. Instead the
Configuration.subset(String) method should be used,
which will return a correctly initialized instance.
| Modifier and Type | Field and Description |
|---|---|
protected String |
delimiter
The prefix delimiter
|
protected Configuration |
parent
The parent configuration.
|
protected String |
prefix
The prefix used to select the properties.
|
END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_READ_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN| Constructor and Description |
|---|
SubsetConfiguration(Configuration parent,
String prefix)
Create a subset of the specified configuration
|
SubsetConfiguration(Configuration parent,
String prefix,
String delimiter)
Create a subset of the specified configuration
|
| Modifier and Type | Method and Description |
|---|---|
void |
addPropertyDirect(String key,
Object value)
Adds a key/value pair to the Configuration.
|
protected void |
clearPropertyDirect(String key)
Removes the specified property from this configuration.
|
boolean |
containsKey(String key)
Check if the configuration contains the specified key.
|
protected String |
getChildKey(String key)
Return the key in the subset configuration associated to the specified
key in the parent configuration.
|
Iterator<String> |
getKeys()
Get the list of the keys contained in the configuration.
|
Iterator<String> |
getKeys(String prefix)
Get the list of the keys contained in the configuration that match the
specified prefix.
|
char |
getListDelimiter()
Returns the list delimiter.
|
Configuration |
getParent()
Return the parent configuration for this subset.
|
protected String |
getParentKey(String key)
Return the key in the parent configuration associated to the specified
key in this subset.
|
String |
getPrefix()
Return the prefix used to select the properties in the parent configuration.
|
Object |
getProperty(String key)
Gets a property from the configuration.
|
protected Object |
interpolate(Object base)
Returns the interpolated value.
|
protected String |
interpolate(String base)
interpolate key names to handle ${key} stuff
|
boolean |
isDelimiterParsingDisabled()
Returns a flag whether string properties should be checked for list
delimiter characters.
|
boolean |
isEmpty()
Check if the configuration is empty.
|
boolean |
isThrowExceptionOnMissing()
Returns true if missing values throw Exceptions.
|
void |
setDelimiterParsingDisabled(boolean delimiterParsingDisabled)
Sets a flag whether list parsing is disabled.
|
void |
setListDelimiter(char delim)
Sets the list delimiter.
|
void |
setPrefix(String prefix)
Set the prefix used to select the properties in the parent configuration.
|
void |
setThrowExceptionOnMissing(boolean throwExceptionOnMissing)
Allows to set the
throwExceptionOnMissing flag. |
Configuration |
subset(String prefix)
Return a decorator Configuration containing every key from the current
Configuration that starts with the specified prefix.
|
addErrorLogListener, addProperty, append, clear, clearProperty, copy, createInterpolator, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDefaultListDelimiter, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getList, getList, getLogger, getLong, getLong, getLong, getProperties, getProperties, getShort, getShort, getShort, getString, getString, getStringArray, getSubstitutor, interpolatedConfiguration, interpolateHelper, isScalarValue, resolveContainerStore, setDefaultListDelimiter, setDelimiter, setLogger, setPropertyaddConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, clone, createErrorEvent, createEvent, fireError, fireEvent, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEventsprotected Configuration parent
protected String prefix
protected String delimiter
public SubsetConfiguration(Configuration parent, String prefix)
parent - The parent configurationprefix - The prefix used to select the propertiespublic SubsetConfiguration(Configuration parent, String prefix, String delimiter)
parent - The parent configurationprefix - The prefix used to select the propertiesdelimiter - The prefix delimiterprotected String getParentKey(String key)
key - The key in the subset.protected String getChildKey(String key)
key - The key in the parent configuration.public Configuration getParent()
public String getPrefix()
public void setPrefix(String prefix)
prefix - the prefixpublic Configuration subset(String prefix)
Configuration
prefix.number = 1
prefix.string = Apache
prefixed.foo = bar
prefix = Jakarta
the Configuration returned by subset("prefix") will contain
the properties:
number = 1
string = Apache
= Jakarta
(The key for the value "Jakarta" is an empty string)
Since the subset is a decorator and not a modified copy of the initial Configuration, any change made to the subset is available to the Configuration, and reciprocally.
subset in interface Configurationsubset in class AbstractConfigurationprefix - The prefix used to select the properties.SubsetConfigurationpublic boolean isEmpty()
Configurationtrue if the configuration contains no property,
false otherwise.public boolean containsKey(String key)
Configurationkey - the key whose presence in this configuration is to be testedtrue if the configuration contains a value for this
key, false otherwisepublic void addPropertyDirect(String key, Object value)
AbstractConfigurationaddPropertyDirect in class AbstractConfigurationkey - key to use for mappingvalue - object to storeprotected void clearPropertyDirect(String key)
AbstractConfigurationclearProperty() after it has done some
preparations. It should be overridden in sub classes. This base
implementation is just left empty.clearPropertyDirect in class AbstractConfigurationkey - the key to be removedpublic Object getProperty(String key)
ConfigurationConfiguration 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 retrievepublic Iterator<String> getKeys(String prefix)
AbstractConfigurationdb.user, db.pwd, db.url, window.xpos, window.ypos,getKeys("db");db.user, db.pwd, db.url.getKeys("db"); will find the keys db,
db.user, or db.password, but not the key
dbdriver.getKeys in interface ConfigurationgetKeys in class AbstractConfigurationprefix - The prefix to test against.Configuration.getKeys()public Iterator<String> getKeys()
Configurationremove() 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.protected Object interpolate(Object base)
AbstractConfigurationinterpolate in class AbstractConfigurationbase - the value to interpolateprotected String interpolate(String base)
AbstractConfigurationinterpolate in class AbstractConfigurationbase - string to interpolatepublic void setThrowExceptionOnMissing(boolean throwExceptionOnMissing)
throwExceptionOnMissing flag. This
flag controls the behavior of property getter methods that return
objects if the requested property is missing. If the flag is set to
false (which is the default value), these methods will return
null. If set to true, they will throw a
NoSuchElementException exception. Note that getter methods
for primitive data types are not affected by this flag.
Change the behavior of the parent configuration if it supports this feature.setThrowExceptionOnMissing in class AbstractConfigurationthrowExceptionOnMissing - The new value for the propertypublic boolean isThrowExceptionOnMissing()
isThrowExceptionOnMissing in class AbstractConfigurationpublic char getListDelimiter()
getListDelimiter in class AbstractConfigurationpublic void setListDelimiter(char delim)
setListDelimiter in class AbstractConfigurationdelim - the new list delimiterpublic boolean isDelimiterParsingDisabled()
isDelimiterParsingDisabled in class AbstractConfigurationpublic void setDelimiterParsingDisabled(boolean delimiterParsingDisabled)
setDelimiterParsingDisabled in class AbstractConfigurationdelimiterParsingDisabled - the delimiter parsing disabled flagCopyright © 2001–2013 The Apache Software Foundation. All rights reserved.