org.apache.avalon.framework.configuration
Class ConfigurationUtil

java.lang.Object
  org.apache.avalon.framework.configuration.ConfigurationUtil

public class ConfigurationUtil

extends java.lang.Object

This class has a bunch of utility methods to work with configuration objects.

Since:

4.1.4

Version:

$Id: ConfigurationUtil.java 506231 2007-02-12 02:36:54Z crossley $

Author:

Avalon Development Team

Method Summary

static boolean	equals(org.apache.avalon.framework.configuration.Configuration c1, org.apache.avalon.framework.configuration.Configuration c2) Test to see if two Configuration's can be considered the same.
static org.apache.avalon.framework.configuration.Configuration	toConfiguration(org.w3c.dom.Element element) Convert a DOM Element tree into a configuration tree.
static org.w3c.dom.Element	toElement(org.apache.avalon.framework.configuration.Configuration configuration) Convert a configuration tree into a DOM Element tree.
static java.lang.String	toString(org.apache.avalon.framework.configuration.Configuration configuration) Serialize the configuration object to a String.

Methods inherited from class java.lang.Object

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

Method Detail

toConfiguration

public static org.apache.avalon.framework.configuration.Configuration toConfiguration(org.w3c.dom.Element element)

Convert a DOM Element tree into a configuration tree.

Parameters:

element - the DOM Element

Returns:

the configuration object

toElement

public static org.w3c.dom.Element toElement(org.apache.avalon.framework.configuration.Configuration configuration)

Convert a configuration tree into a DOM Element tree.

Parameters:

configuration - the configuration object

Returns:

the DOM Element

toString

public static java.lang.String toString(org.apache.avalon.framework.configuration.Configuration configuration)

Serialize the configuration object to a String. If an exception occurs, the exception message will be returned instead. This method is intended to aid debugging; DefaultConfigurationSerializer.serialize(Configuration) lets the caller handle exceptions.

Parameters:

configuration - Configuration instance to serialize

Returns:

a non-null String representing the Configuration, or an error message.

Since:

12 March, 2003

equals

public static boolean equals(org.apache.avalon.framework.configuration.Configuration c1,
                             org.apache.avalon.framework.configuration.Configuration c2)

Test to see if two Configuration's can be considered the same. Name, value, attributes and children are test. The order of children is not taken into consideration for equality.

Parameters:

c1 - Configuration to test

c2 - Configuration to test

Returns:

true if the configurations can be considered equals