org.apache.commons.configuration
Class XMLPropertiesConfiguration
java.lang.Object
org.apache.commons.configuration.event.EventSource
org.apache.commons.configuration.AbstractConfiguration
org.apache.commons.configuration.BaseConfiguration
org.apache.commons.configuration.AbstractFileConfiguration
org.apache.commons.configuration.PropertiesConfiguration
org.apache.commons.configuration.XMLPropertiesConfiguration
- All Implemented Interfaces:
- Cloneable, Configuration, FileConfiguration
- public class XMLPropertiesConfiguration
- extends PropertiesConfiguration
This configuration implements the XML properties format introduced in Java
5.0, see http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html.
An XML properties file looks like this:
<?xml version="1.0"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<comment>Description of the property list</comment>
<entry key="key1">value1</entry>
<entry key="key2">value2</entry>
<entry key="key3">value3</entry>
</properties>
The Java 5.0 runtime is not required to use this class. The default encoding
for this configuration format is UTF-8. Note that unlike
PropertiesConfiguration
, XMLPropertiesConfiguration
does not support includes.
Note:Configuration objects of this type can be read concurrently
by multiple threads. However if one of these threads modifies the object,
synchronization has to be performed manually.
- Since:
- 1.1
- Version:
- $Revision: 548098 $, $Date: 2007-06-17 21:34:03 +0200 (So, 17 Jun 2007) $
- Author:
- Emmanuel Bourg, Alistair Young
Method Summary |
void |
load(Reader in)
Load the properties from the given reader.
|
void |
save(Writer out)
Save the configuration to the specified stream. |
Methods inherited from class org.apache.commons.configuration.PropertiesConfiguration |
clone, createLayout, getEncoding, getHeader, getInclude, getIncludesAllowed, getLayout, setBasePath, setHeader, setInclude, setIncludesAllowed, setLayout, unescapeJava |
Methods inherited from class org.apache.commons.configuration.AbstractFileConfiguration |
addProperty, clearProperty, containsKey, enterNoReload, exitNoReload, fireEvent, getBasePath, getFile, getFileName, getKeys, getPath, getProperty, getReloadingStrategy, getURL, isAutoSave, isEmpty, load, load, load, load, load, load, possiblySave, reload, save, save, save, save, save, save, setAutoSave, setEncoding, setFile, setFileName, setPath, setProperty, setReloadingStrategy, setURL |
Methods inherited from class org.apache.commons.configuration.AbstractConfiguration |
addErrorLogListener, append, copy, createInterpolator, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDefaultListDelimiter, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getKeys, getList, getList, getListDelimiter, getLogger, getLong, getLong, getLong, getProperties, getProperties, getShort, getShort, getShort, getString, getString, getStringArray, getSubstitutor, interpolate, interpolate, interpolatedConfiguration, interpolateHelper, isDelimiterParsingDisabled, isThrowExceptionOnMissing, resolveContainerStore, setDefaultListDelimiter, setDelimiter, setDelimiterParsingDisabled, setListDelimiter, setLogger, setThrowExceptionOnMissing, subset |
Methods inherited from class org.apache.commons.configuration.event.EventSource |
addConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, createErrorEvent, createEvent, fireError, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEvents |
Methods inherited from interface org.apache.commons.configuration.Configuration |
clear, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getKeys, getList, getList, getLong, getLong, getLong, getProperties, getShort, getShort, getShort, getString, getString, getStringArray, subset |
XMLPropertiesConfiguration
public XMLPropertiesConfiguration()
- Creates an empty XMLPropertyConfiguration object which can be
used to synthesize a new Properties file by adding values and
then saving(). An object constructed by this C'tor can not be
tickled into loading included files because it cannot supply a
base for relative includes.
XMLPropertiesConfiguration
public XMLPropertiesConfiguration(String fileName)
throws ConfigurationException
- Creates and loads the xml properties from the specified file.
The specified file can contain "include" properties which then
are loaded and merged into the properties.
- Parameters:
fileName
- The name of the properties file to load.
- Throws:
ConfigurationException
- Error while loading the properties file
XMLPropertiesConfiguration
public XMLPropertiesConfiguration(File file)
throws ConfigurationException
- Creates and loads the xml properties from the specified file.
The specified file can contain "include" properties which then
are loaded and merged into the properties.
- Parameters:
file
- The properties file to load.
- Throws:
ConfigurationException
- Error while loading the properties file
XMLPropertiesConfiguration
public XMLPropertiesConfiguration(URL url)
throws ConfigurationException
- Creates and loads the xml properties from the specified URL.
The specified file can contain "include" properties which then
are loaded and merged into the properties.
- Parameters:
url
- The location of the properties file to load.
- Throws:
ConfigurationException
- Error while loading the properties file
load
public void load(Reader in)
throws ConfigurationException
- Description copied from class:
PropertiesConfiguration
- Load the properties from the given reader.
Note that the
clear()
method is not called, so
the properties contained in the loaded file will be added to the
actual set of properties.
- Specified by:
load
in interface FileConfiguration
- Overrides:
load
in class PropertiesConfiguration
- Parameters:
in
- An InputStream.
- Throws:
ConfigurationException
- if an error occurs
save
public void save(Writer out)
throws ConfigurationException
- Description copied from class:
PropertiesConfiguration
- Save the configuration to the specified stream.
- Specified by:
save
in interface FileConfiguration
- Overrides:
save
in class PropertiesConfiguration
- Parameters:
out
- the output stream used to save the configuration
- Throws:
ConfigurationException
- if an error occurs
Copyright © 2001-2008 The Apache Software Foundation. All Rights Reserved.