com.sdl.web.client.configuration

Class XMLConfigurationHolder

java.lang.Object

com.sdl.web.client.configuration.XMLConfigurationHolder

All Implemented Interfaces:

ConfigurationHolder

public class XMLConfigurationHolder
extends Object
implements ConfigurationHolder

It represents a XML 'Configuration' holder.

Field Summary

Fields inherited from interface com.sdl.web.client.configuration.api.ConfigurationHolder

LOG

Constructor Summary

Constructors

Constructor and Description
XMLConfigurationHolder(Node xmlConfiguration)

Method Summary

Modifier and Type	Method and Description
ConfigurationHolder	getConfiguration(ConfigurationPath path) Get the configuration for the given path.
String	getValue(String name) Get the value from the current configuration node accessed by the given name.
Map<String,String>	getValues() Get all the values from current configuration node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sdl.web.client.configuration.api.ConfigurationHolder

getConfiguration, hasConfiguration, hasConfiguration

Constructor Detail

XMLConfigurationHolder

public XMLConfigurationHolder(Node xmlConfiguration)

Method Detail

getConfiguration

public ConfigurationHolder getConfiguration(ConfigurationPath path)
                                     throws ConfigurationException

Description copied from interface: ConfigurationHolder

Get the configuration for the given path. Take into account that sometimes a given path could lead to a list of configurations of the same type grouped inside a parent configuration. By using this method, in case of the path lead to a list of configurations of the same type it will return the first configuration of the list. In the case the path lead to a single configuration, such configuration would be retrieved.

Specified by:

getConfiguration in interface ConfigurationHolder

Parameters:

path - The given path.

Returns:

The 'configuration' for the given path or null if not found.

Throws:

ConfigurationException - In case of configuration problem

getValue

public String getValue(String name)
                throws ConfigurationException

Description copied from interface: ConfigurationHolder

Get the value from the current configuration node accessed by the given name.

Specified by:

getValue in interface ConfigurationHolder

Parameters:

name - The given name to access the configuration value

Returns:

The value from the current configuration node accessed by the given name

Throws:

ConfigurationException - in case of configuration problem

getValues

public Map<String,String> getValues()
                             throws ConfigurationException

Description copied from interface: ConfigurationHolder

Get all the values from current configuration node.

Specified by:

getValues in interface ConfigurationHolder

Returns:

All the values from current configuration node

Throws:

ConfigurationException - in case of configuration problem