HierarchicalXMLConfiguration (Commons Configuration 1.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.configuration
Class HierarchicalXMLConfiguration

java.lang.Object
  org.apache.commons.configuration.AbstractConfiguration
      org.apache.commons.configuration.HierarchicalConfiguration
          org.apache.commons.configuration.HierarchicalXMLConfiguration

All Implemented Interfaces:: Configuration, FileConfiguration

public class HierarchicalXMLConfiguration
extends HierarchicalConfiguration
implements FileConfiguration

A specialized hierarchical configuration class that is able to parse XML documents.

The parsed document will be stored keeping its structure. The contained properties can be accessed using all methods supported by the base class HierarchicalConfiguration.

Since:: commons-configuration 1.0
Version:: $Revision: 1.3 $, $Date: 2004/09/22 17:17:30 $
Author:: Jörg Schaible, Oliver Heger

Nested Class Summary

Nested classes inherited from class org.apache.commons.configuration.HierarchicalConfiguration

HierarchicalConfiguration.CloneVisitor, HierarchicalConfiguration.DefinedKeysVisitor, HierarchicalConfiguration.DefinedVisitor, HierarchicalConfiguration.Node, HierarchicalConfiguration.NodeVisitor

Nested classes inherited from class org.apache.commons.configuration.AbstractConfiguration

AbstractConfiguration.PropertiesTokenizer

Field Summary

Fields inherited from class org.apache.commons.configuration.AbstractConfiguration

END_TOKEN, START_TOKEN

Constructor Summary
`HierarchicalXMLConfiguration()`

Method Summary
`String`	`getBasePath()` Return the base path.
`File`	`getFile()` Return the file where the configuration is stored.
`String`	`getFileName()` Return the name of the file.
`URL`	`getURL()` Return the URL where the configuration is stored.
`void`	`initProperties(Document document)` Initializes this configuration from an XML document.
`void`	`load()` Load the configuration from the underlying URL.
`void`	`load(File file)` Load the configuration from the specified file.
`void`	`load(InputStream in)` Load the configuration from the specified stream, using the default platform specific encoding.
`void`	`load(InputStream in, String encoding)` Load the configuration from the specified stream, using the specified encoding.
`void`	`load(Reader in)` Load the configuration from the specified reader.
`void`	`load(String fileName)` Locate the specified file and load the configuration.
`void`	`load(URL url)` Load the configuration from the specified URL.
`void`	`save()` Save the configuration.
`void`	`save(File file)` Save the configuration to the specified file.
`void`	`save(OutputStream out)` Save the configuration to the specified stream.
`void`	`save(OutputStream out, String encoding)` Save the configuration to the specified stream, using the specified encoding.
`void`	`save(String fileName)` Save the configuration to the specified file.
`void`	`save(URL url)` Save the configuration to the specified URL if it's a file URL.
`void`	`save(Writer out)` Save the configuration to the specified writer.
`void`	`setBasePath(String basePath)` Set the base path.
`void`	`setFile(File file)` Set the file where the configuration is stored.
`void`	`setFileName(String fileName)` Set the name of the file.
`void`	`setURL(URL url)` The URL where the configuration is stored.

Methods inherited from class org.apache.commons.configuration.HierarchicalConfiguration

addNodes, addPropertyDirect, clearProperty, containsKey, createAddPath, fetchAddNode, fetchNodeList, findLastPathNode, findPropertyNodes, getKeys, getMaxIndex, getPropertyDirect, getRoot, isEmpty, nodeDefined, removeNode, setRoot, subset

Methods inherited from class org.apache.commons.configuration.AbstractConfiguration

addProperty, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getKeys, getList, getList, getLong, getLong, getLong, getProperties, getProperties, getProperty, getShort, getShort, getShort, getString, getString, getStringArray, getVector, getVector, interpolate, interpolateHelper, isThrowExceptionOnMissing, setDelimiter, setProperty, setThrowExceptionOnMissing, split

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.commons.configuration.Configuration

addProperty, clearProperty, containsKey, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getKeys, getKeys, getList, getList, getLong, getLong, getLong, getProperties, getProperty, getShort, getShort, getShort, getString, getString, getStringArray, getVector, getVector, isEmpty, setProperty, subset

Constructor Detail

HierarchicalXMLConfiguration

public HierarchicalXMLConfiguration()

Method Detail

initProperties

public void initProperties(Document document)

Initializes this configuration from an XML document.

Parameters:: document - the document to be parsed