com.sdl.web.client.configuration.api

Interface ConfigurationHolder

All Known Implementing Classes:

XMLConfigurationHolder

public interface ConfigurationHolder

It represents a 'Configuration' holder which can hold sub-configurations and configuration values.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG Logger.

Method Summary

Modifier and Type	Method and Description
ConfigurationHolder	getConfiguration(ConfigurationPath path) Get the configuration for the given path.
default ConfigurationHolder	getConfiguration(String path) Syntactic sugar for getConfiguration(ConfigurationPath).
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.
default boolean	hasConfiguration(ConfigurationPath path) Helper method to check if provided path exists in the configuration.
default boolean	hasConfiguration(String path) Syntactic sugar for hasConfiguration(ConfigurationPath).

Field Detail

LOG

static final org.slf4j.Logger LOG

Logger.

Method Detail

hasConfiguration

default boolean hasConfiguration(String path)

Syntactic sugar for hasConfiguration(ConfigurationPath).

Parameters:

path - The given path

Returns:

true if the path element exists, otherwise false

hasConfiguration

default boolean hasConfiguration(ConfigurationPath path)

Helper method to check if provided path exists in the configuration.

Parameters:

path - The given path

Returns:

true if the path element exists, otherwise false

getConfiguration

default ConfigurationHolder getConfiguration(String path)
                                      throws ConfigurationException

Syntactic sugar for getConfiguration(ConfigurationPath).

Parameters:

path - The string representation of configuration path.

Returns:

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

Throws:

ConfigurationException - in case of configuration problem

getConfiguration

ConfigurationHolder getConfiguration(ConfigurationPath path)
                              throws ConfigurationException

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.

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

String getValue(String name)
         throws ConfigurationException

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

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

Map<String,String> getValues()
                      throws ConfigurationException

Get all the values from current configuration node.

Returns:

All the values from current configuration node

Throws:

ConfigurationException - in case of configuration problem