|
||||||||||
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.HierarchicalConfiguration
org.apache.commons.configuration.AbstractHierarchicalFileConfiguration
org.apache.commons.configuration.XMLConfiguration
public class XMLConfiguration
A specialized hierarchical configuration class that is able to parse XML documents.
The parsed document will be stored keeping its structure. The class also
tries to preserve as much information from the loaded XML document as
possible, including comments and processing instructions. These will be
contained in documents created by the save()
methods, too.
Like other file based configuration classes this class maintains the name
and path to the loaded configuration file. These properties can be altered
using several setter methods, but they are not modified by save()
and load()
methods. If XML documents contain relative paths to
other documents (e.g. to a DTD), these references are resolved based on the
path set for this configuration.
By inheriting from
this class
provides some extended functionaly, e.g. interpolation of property values.
Like in AbstractConfiguration
property values can
contain delimiter characters (the comma ',' per default) and are then splitted
into multiple values. This works for XML attributes and text content of
elements as well. The delimiter can be escaped by a backslash. As an example
consider the following XML fragment:PropertiesConfiguration
<config> <array>10,20,30,40</array> <scalar>3\,1415</scalar> <cite text="To be or not to be\, this is the question!"/> </config>
Here the content of the array
element will be splitted at
the commas, so the array
key will be assigned 4 values. In the
scalar
property and the text
attribute of the
cite
element the comma is escaped, so that no splitting is
performed.
XMLConfiguration
implements the
interface and thus provides full support for loading XML documents from
different sources like files, URLs, or streams. A full description of these
features can be found in the documentation of
FileConfiguration
.AbstractFileConfiguration
Nested Class Summary | |
---|---|
(package private) static class |
XMLConfiguration.XMLBuilderVisitor
A concrete BuilderVisitor that can construct XML
documents. |
(package private) class |
XMLConfiguration.XMLNode
A specialized Node class that is connected with an XML
element. |
Nested classes/interfaces inherited from class org.apache.commons.configuration.AbstractHierarchicalFileConfiguration |
---|
AbstractHierarchicalFileConfiguration.FileConfigurationDelegate |
Nested classes/interfaces inherited from class org.apache.commons.configuration.HierarchicalConfiguration |
---|
HierarchicalConfiguration.BuilderVisitor, HierarchicalConfiguration.CloneVisitor, HierarchicalConfiguration.DefinedKeysVisitor, HierarchicalConfiguration.DefinedVisitor, HierarchicalConfiguration.Node, HierarchicalConfiguration.NodeVisitor |
Field Summary |
---|
Fields inherited from class org.apache.commons.configuration.HierarchicalConfiguration |
---|
EVENT_ADD_NODES, EVENT_CLEAR_TREE |
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 | |
---|---|
XMLConfiguration()
Creates a new instance of XMLConfiguration . |
|
XMLConfiguration(File file)
Creates a new instance of XMLConfiguration . |
|
XMLConfiguration(HierarchicalConfiguration c)
Creates a new instance of XMLConfiguration and copies the
content of the passed in configuration into this object. |
|
XMLConfiguration(String fileName)
Creates a new instance of XMLConfiguration . |
|
XMLConfiguration(URL url)
Creates a new instance of XMLConfiguration . |
Method Summary | |
---|---|
void |
clear()
Removes all properties from this configuration. |
Object |
clone()
Creates a copy of this object. |
protected AbstractHierarchicalFileConfiguration.FileConfigurationDelegate |
createDelegate()
Creates the file configuration delegate for this object. |
protected Document |
createDocument()
Creates a DOM document from the internal tree of configuration nodes. |
protected DocumentBuilder |
createDocumentBuilder()
Creates the DocumentBuilder to be used for loading files. |
protected HierarchicalConfiguration.Node |
createNode(String name)
Creates a new node object. |
protected Transformer |
createTransformer()
Creates and initializes the transformer used for save operations. |
Document |
getDocument()
Returns the XML document this configuration was loaded from. |
DocumentBuilder |
getDocumentBuilder()
Returns the DocumentBuilder object that is used for
loading documents. |
String |
getPublicID()
Returns the public ID of the DOCTYPE declaration from the loaded XML document. |
String |
getRootElementName()
Returns the name of the root element. |
String |
getSystemID()
Returns the system ID of the DOCTYPE declaration from the loaded XML document. |
void |
initProperties(Document document,
boolean elemRefs)
Initializes this configuration from an XML document. |
boolean |
isValidating()
Returns the value of the validating flag. |
void |
load(InputStream in)
Loads the configuration from the given input stream. |
void |
load(Reader in)
Load the configuration from the given reader. |
void |
save(Writer writer)
Saves the configuration to the specified writer. |
void |
setDocumentBuilder(DocumentBuilder documentBuilder)
Sets the DocumentBuilder object to be used for loading
documents. |
void |
setPublicID(String publicID)
Sets the public ID of the DOCTYPE declaration. |
void |
setRootElementName(String name)
Sets the name of the root element. |
void |
setSystemID(String systemID)
Sets the system ID of the DOCTYPE declaration. |
void |
setValidating(boolean validating)
Sets the value of the validating flag. |
Methods inherited from class org.apache.commons.configuration.AbstractHierarchicalFileConfiguration |
---|
addPropertyDirect, clearProperty, clearTree, configurationChanged, containsKey, fetchNodeList, getBasePath, getDelegate, getEncoding, getFile, getFileName, getKeys, getProperty, getReloadingStrategy, getURL, isAutoSave, isEmpty, load, load, load, load, load, reload, save, save, save, save, save, save, setAutoSave, setBasePath, setDelegate, setEncoding, setFile, setFileName, setProperty, setReloadingStrategy, setURL |
Methods inherited from class org.apache.commons.configuration.HierarchicalConfiguration |
---|
addNodes, clearNode, clearNode, clearReferences, configurationAt, configurationsAt, createAddPath, createSubnodeConfiguration, fetchAddNode, findLastPathNode, findPropertyNodes, getDefaultExpressionEngine, getExpressionEngine, getKeys, getMaxIndex, getRoot, getRootNode, nodeDefined, nodeDefined, removeNode, removeNode, setDefaultExpressionEngine, setExpressionEngine, setRoot, setRootNode, subset |
Methods inherited from class org.apache.commons.configuration.event.EventSource |
---|
addConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, 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 |
Methods inherited from interface org.apache.commons.configuration.Configuration |
---|
addProperty, 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 |
Constructor Detail |
---|
public XMLConfiguration()
XMLConfiguration
.
public XMLConfiguration(HierarchicalConfiguration c)
XMLConfiguration
and copies the
content of the passed in configuration into this object. Note that only
the data of the passed in configuration will be copied. If, for instance,
the other configuration is a XMLConfiguration
, too,
things like comments or processing instructions will be lost.
c
- the configuration to copypublic XMLConfiguration(String fileName) throws ConfigurationException
XMLConfiguration
. The
configuration is loaded from the specified file
fileName
- the name of the file to load
ConfigurationException
- if the file cannot be loadedpublic XMLConfiguration(File file) throws ConfigurationException
XMLConfiguration
.
The configuration is loaded from the specified file.
file
- the file
ConfigurationException
- if an error occurs while loading the filepublic XMLConfiguration(URL url) throws ConfigurationException
XMLConfiguration
.
The configuration is loaded from the specified URL.
url
- the URL
ConfigurationException
- if loading causes an errorMethod Detail |
---|
public String getRootElementName()
public void setRootElementName(String name)
UnsupportedOperationException
exception is thrown. Whether this configuration has been loaded from an
XML document or not can be found out using the getDocument()
method.
name
- the name of the root elementpublic DocumentBuilder getDocumentBuilder()
DocumentBuilder
object that is used for
loading documents. If no specific builder has been set, this method
returns null.
DocumentBuilder
for loading new documentspublic void setDocumentBuilder(DocumentBuilder documentBuilder)
DocumentBuilder
object to be used for loading
documents. This method makes it possible to specify the exact document
builder. So an application can create a builder, configure it for its
special needs, and then pass it to this method.
documentBuilder
- the document builder to be used; if undefined, a
default builder will be usedpublic String getPublicID()
public void setPublicID(String publicID)
publicID
- the public IDpublic String getSystemID()
public void setSystemID(String systemID)
systemID
- the system IDpublic boolean isValidating()
public void setValidating(boolean validating)
DocumentBuilder
was set.
validating
- the validating flagpublic Document getDocument()
public void clear()
clear
in interface Configuration
clear
in class AbstractConfiguration
public void initProperties(Document document, boolean elemRefs)
document
- the document to be parsedelemRefs
- a flag whether references to the XML elements should be setprotected DocumentBuilder createDocumentBuilder() throws ParserConfigurationException
DocumentBuilder
to be used for loading files.
This implementation checks whether a specific
DocumentBuilder
has been set. If this is the case, this
one is used. Otherwise a default builder is created. Depending on the
value of the validating flag this builder will be a validating or a non
validating DocumentBuilder
.
DocumentBuilder
for loading configuration
files
ParserConfigurationException
- if an error occursprotected Document createDocument() throws ConfigurationException
ConfigurationException
- if an error occursprotected HierarchicalConfiguration.Node createNode(String name)
XMLNode
class.
createNode
in class HierarchicalConfiguration
name
- the node's name
public void load(InputStream in) throws ConfigurationException
load
in interface FileConfiguration
load
in class AbstractHierarchicalFileConfiguration
in
- the input stream
ConfigurationException
- if an error occurspublic void load(Reader in) throws ConfigurationException
clear()
method is not called, so
the properties contained in the loaded file will be added to the
actual set of properties.
in
- An InputStream.
ConfigurationException
- if an error occurspublic void save(Writer writer) throws ConfigurationException
writer
- the writer used to save the configuration
ConfigurationException
- if an error occursprotected Transformer createTransformer() throws TransformerException
TransformerException
- if an error occurspublic Object clone()
clone
in class HierarchicalConfiguration
protected AbstractHierarchicalFileConfiguration.FileConfigurationDelegate createDelegate()
FileConfigurationDelegate
that deals with some specialities of XMLConfiguration
.
createDelegate
in class AbstractHierarchicalFileConfiguration
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |