com.sdl.delivery.configuration.utils

Class ConfigurationUtils

java.lang.Object

com.sdl.delivery.configuration.utils.ConfigurationUtils

public class ConfigurationUtils
extends Object

Class with some useful generic utility methods to process configurations of type Configuration.

Constructor Summary

Constructors

Constructor and Description
ConfigurationUtils()

Method Summary

Modifier and Type	Method and Description
static String	getNonEmptyString(com.sdl.delivery.configuration.Configuration configuration, String valueName, String errorMessage) Get the configuration value as type String from the given configuration and value name.
static Optional<com.sdl.delivery.configuration.Value>	getValue(com.sdl.delivery.configuration.Configuration configuration, String valueName) Get the configuration value from the given configuration and value name.
static com.sdl.delivery.configuration.Value	getValue(com.sdl.delivery.configuration.Configuration configuration, String valueName, String errorMessage) Get the configuration value from the given configuration and value name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationUtils

public ConfigurationUtils()

Method Detail

getNonEmptyString

public static String getNonEmptyString(com.sdl.delivery.configuration.Configuration configuration,
                                       String valueName,
                                       String errorMessage)
                                throws com.sdl.delivery.configuration.ConfigurationException

Get the configuration value as type String from the given configuration and value name. In case the value is not present or is an empty String, a ConfigurationException with the given message is thrown. This means that if there is a value is guaranteed to not be null neither empty.

Parameters:

configuration - The given configuration. It can not be null.

valueName - The given value name. It can not be @{code null} nor empty.

errorMessage - The error message that should appear in the ConfigurationException when thrown. It can not be null nor empty.

Returns:

The configuration value. Guaranteed to not be null.

Throws:

com.sdl.delivery.configuration.ConfigurationException - In case the value can not be found.

getValue

public static com.sdl.delivery.configuration.Value getValue(com.sdl.delivery.configuration.Configuration configuration,
                                                            String valueName,
                                                            String errorMessage)
                                                     throws com.sdl.delivery.configuration.ConfigurationException

Get the configuration value from the given configuration and value name. In case the value is not present, a ConfigurationException with the given message is thrown. This means that if there is a value is guaranteed to not be null.

Parameters:

configuration - The given configuration. It can not be null.

valueName - The given value name. It can not be @{code null} nor empty.

errorMessage - The error message that should appear in the ConfigurationException when thrown. It can not be null nor empty.

Returns:

The configuration value. Guaranteed to not be null.

Throws:

com.sdl.delivery.configuration.ConfigurationException - In case the value can not be found.

getValue

public static Optional<com.sdl.delivery.configuration.Value> getValue(com.sdl.delivery.configuration.Configuration configuration,
                                                                      String valueName)

Get the configuration value from the given configuration and value name.

Parameters:

configuration - The given configuration. It can not be null.

valueName - The given value name. It can not be @{code null} nor empty.

Returns:

The configuration value as an option.