public class XMLPropertiesConfiguration extends PropertiesConfiguration
<?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.PropertiesConfiguration.DefaultIOFactory, PropertiesConfiguration.IOFactory, PropertiesConfiguration.PropertiesReader, PropertiesConfiguration.PropertiesWriter
autoSave, basePath, EVENT_CONFIG_CHANGED, EVENT_RELOAD, fileName, reloadLock, strategy
END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_READ_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN
Constructor and Description |
---|
XMLPropertiesConfiguration()
Creates an empty XMLPropertyConfiguration object which can be
used to synthesize a new Properties file by adding values and
then saving().
|
XMLPropertiesConfiguration(Element element)
Creates and loads the xml properties from the specified DOM node.
|
XMLPropertiesConfiguration(File file)
Creates and loads the xml properties from the specified file.
|
XMLPropertiesConfiguration(String fileName)
Creates and loads the xml properties from the specified file.
|
XMLPropertiesConfiguration(URL url)
Creates and loads the xml properties from the specified URL.
|
Modifier and Type | Method and Description |
---|---|
void |
load(Element element)
Parses a DOM element containing the properties.
|
void |
load(Reader in)
Load the properties from the given reader.
|
void |
save(Document document,
Node parent)
Writes the configuration as child to the given DOM node
|
void |
save(Writer out)
Save the configuration to the specified stream.
|
clone, createLayout, getEncoding, getFooter, getHeader, getInclude, getIncludesAllowed, getIOFactory, getLayout, isIncludesAllowed, setBasePath, setFooter, setHeader, setInclude, setIncludesAllowed, setIOFactory, setLayout, unescapeJava
addProperty, clearProperty, closeSilent, configurationChanged, containsKey, enterNoReload, exitNoReload, fireEvent, getBasePath, getFile, getFileName, getFileSystem, getKeys, getPath, getProperty, getReloadingStrategy, getReloadLock, getURL, isAutoSave, isEmpty, load, load, load, load, load, load, possiblySave, refresh, reload, reload, resetFileSystem, save, save, save, save, save, save, setAutoSave, setEncoding, setFile, setFileName, setFileSystem, setPath, setProperty, setReloadingStrategy, setURL
addPropertyDirect, clear, clearPropertyDirect
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, isScalarValue, isThrowExceptionOnMissing, resolveContainerStore, setDefaultListDelimiter, setDelimiter, setDelimiterParsingDisabled, setListDelimiter, setLogger, setThrowExceptionOnMissing, subset
addConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, createErrorEvent, createEvent, fireError, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEvents
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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
public XMLPropertiesConfiguration()
public XMLPropertiesConfiguration(String fileName) throws ConfigurationException
fileName
- The name of the properties file to load.ConfigurationException
- Error while loading the properties filepublic XMLPropertiesConfiguration(File file) throws ConfigurationException
file
- The properties file to load.ConfigurationException
- Error while loading the properties filepublic XMLPropertiesConfiguration(URL url) throws ConfigurationException
url
- The location of the properties file to load.ConfigurationException
- Error while loading the properties filepublic XMLPropertiesConfiguration(Element element) throws ConfigurationException
element
- The DOM elementConfigurationException
- Error while loading the properties filepublic void load(Reader in) throws ConfigurationException
PropertiesConfiguration
clear()
method is not called, so
the properties contained in the loaded file will be added to the
actual set of properties.load
in interface FileConfiguration
load
in class PropertiesConfiguration
in
- An InputStream.ConfigurationException
- if an error occurspublic void load(Element element) throws ConfigurationException
element
- The DOM elementConfigurationException
- Error while interpreting the DOMpublic void save(Writer out) throws ConfigurationException
PropertiesConfiguration
save
in interface FileConfiguration
save
in class PropertiesConfiguration
out
- the output stream used to save the configurationConfigurationException
- if an error occursCopyright © 2001–2013 The Apache Software Foundation. All rights reserved.