java.lang.Cloneable, Configuration, EventSource, FileBasedConfiguration, ImmutableConfiguration, FileBased, FileLocatorAware, SynchronizerSupportpublic class XMLPropertiesConfiguration extends BaseConfiguration implements FileBasedConfiguration, FileLocatorAware
<?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.| Modifier and Type | Field | Description |
|---|---|---|
static java.lang.String |
DEFAULT_ENCODING |
The default encoding (UTF-8 as specified by http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html)
|
| Constructor | Description |
|---|---|
XMLPropertiesConfiguration() |
Creates an empty XMLPropertyConfiguration object which can be
used to synthesize a new Properties file by adding values and
then saving().
|
XMLPropertiesConfiguration(org.w3c.dom.Element element) |
Creates and loads the xml properties from the specified DOM node.
|
| Modifier and Type | Method | Description |
|---|---|---|
java.lang.String |
getHeader() |
Returns the header comment of this configuration.
|
void |
initFileLocator(FileLocator locator) |
Initializes this object with a
FileLocator. |
void |
load(org.w3c.dom.Element element) |
Parses a DOM element containing the properties.
|
void |
read(java.io.Reader in) |
Reads the content of this object from the given reader.
|
void |
save(org.w3c.dom.Document document,
org.w3c.dom.Node parent) |
Writes the configuration as child to the given DOM node
|
void |
setHeader(java.lang.String header) |
Sets the header comment of this configuration.
|
void |
write(java.io.Writer out) |
Writes the content of this object to the given writer.
|
addErrorLogListener, addProperty, addPropertyInternal, append, beginRead, beginWrite, clear, clearProperty, cloneInterpolator, containsKey, copy, endRead, endWrite, get, get, getArray, getArray, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCollection, getCollection, getConfigurationDecoder, getConversionHandler, getDouble, getDouble, getDouble, getEncodedString, getEncodedString, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getKeys, getKeys, getKeysInternal, getList, getList, getList, getList, getListDelimiterHandler, getLogger, getLong, getLong, getLong, getProperties, getProperties, getProperty, getShort, getShort, getShort, getString, getString, getStringArray, getSynchronizer, immutableSubset, initLogger, installInterpolator, interpolate, interpolate, interpolatedConfiguration, isEmpty, isScalarValue, isThrowExceptionOnMissing, lock, setConfigurationDecoder, setConversionHandler, setDefaultLookups, setInterpolator, setListDelimiterHandler, setLogger, setParentInterpolator, setPrefixLookups, setProperty, setPropertyInternal, setSynchronizer, setThrowExceptionOnMissing, size, subset, unlockaddPropertyDirect, clearInternal, clearPropertyDirect, clone, containsKeyInternal, getKeysInternal, getPropertyInternal, isEmptyInternal, sizeInternaladdEventListener, clearErrorListeners, clearEventListeners, copyEventListeners, createErrorEvent, createEvent, fireError, fireEvent, getEventListenerRegistrations, getEventListeners, isDetailEvents, removeEventListener, setDetailEventsaddProperty, clear, clearProperty, getInterpolator, installInterpolator, setInterpolator, setProperty, subsetcontainsKey, get, get, getArray, getArray, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCollection, getCollection, getDouble, getDouble, getDouble, getEncodedString, getEncodedString, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getKeys, getKeys, getList, getList, getList, getList, getLong, getLong, getLong, getProperties, getProperty, getShort, getShort, getShort, getString, getString, getStringArray, immutableSubset, isEmpty, sizeequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetSynchronizer, lock, setSynchronizer, unlockpublic static final java.lang.String DEFAULT_ENCODING
public XMLPropertiesConfiguration()
public XMLPropertiesConfiguration(org.w3c.dom.Element element)
throws ConfigurationException
element - The DOM elementConfigurationException - Error while loading the properties filepublic java.lang.String getHeader()
public void setHeader(java.lang.String header)
header - the header commentpublic void read(java.io.Reader in)
throws ConfigurationException
FileBasedFileHandler for reading data.read in interface FileBasedin - the readerConfigurationException - if a non-I/O related problem occurs, e.g.
the data read does not have the expected formatpublic void load(org.w3c.dom.Element element)
throws ConfigurationException
element - The DOM elementConfigurationException - Error while interpreting the DOMpublic void write(java.io.Writer out)
throws ConfigurationException
FileBasedFileHandler for writing data.write in interface FileBasedout - the writerConfigurationException - if a non-I/O related problem occurs, e.g.
the data read does not have the expected formatpublic void save(org.w3c.dom.Document document,
org.w3c.dom.Node parent)
document - The DOM document to add the configuration toparent - The DOM parent nodepublic void initFileLocator(FileLocator locator)
FileLocator. The locator is
accessed during load and save operations.initFileLocator in interface FileLocatorAwarelocator - the associated FileLocatorCopyright © 2001–2018. All rights reserved.