com.sdl.delivery.configuration.utils

Class ConfigurationPropertyUtils

java.lang.Object

com.sdl.delivery.configuration.utils.ConfigurationPropertyUtils

public class ConfigurationPropertyUtils
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_VALUE_PROPERTY_NAME Configuration Value used to specify a 'Property Name'.
static String	CONFIG_VALUE_PROPERTY_VALUE Configuration Value used to specify a 'Property Value'.

Constructor Summary

Constructors

Constructor and Description
ConfigurationPropertyUtils()

Method Summary

Modifier and Type	Method and Description
static Optional<BigDecimal>	getBigDecimalProperty(com.sdl.delivery.configuration.Configuration propertiesConfig, String propertyName) Get the property value as type BigDecimal from the given 'Properties Configuration' by the given property name.
static Optional<BigInteger>	getBigIntegerProperty(com.sdl.delivery.configuration.Configuration propertiesConfig, String propertyName) Get the property value as type BigInteger from the given 'Properties Configuration' by the given property name.
static Optional<Boolean>	getBooleanProperty(com.sdl.delivery.configuration.Configuration propertiesConfig, String propertyName) Get the property value as type Boolean from the given 'Properties Configuration' by the given property name.
static Optional<Map<String,String>>	getConfigurationAsStringValues(Map<String,com.sdl.delivery.configuration.Value> configValuesMap) Converts a Map containing configuration values ( Map) to Map.
static Optional<Calendar>	getDateProperty(com.sdl.delivery.configuration.Configuration propertiesConfig, String propertyName) Get the property value as type Calendar from the given 'Properties Configuration' by the given property name.
static Optional<Double>	getDoubleProperty(com.sdl.delivery.configuration.Configuration propertiesConfig, String propertyName) Get the property value as type Double from the given 'Properties Configuration' by the given property name.
static Optional<Long>	getLongProperty(com.sdl.delivery.configuration.Configuration propertiesConfig, String propertyName) Get the property value as type Long from the given 'Properties Configuration' by the given property name.
static Optional<com.sdl.delivery.configuration.Value>	getNameProperty(com.sdl.delivery.configuration.Configuration propertyConfig) Get the property name configuration value from the given 'Property configuration' (of type <Property Name="X" Value="Y" /> in case it is represented as XML).
static String	getNonEmptyStringProperty(com.sdl.delivery.configuration.Configuration propertiesConfig, String propertyName, String errorMessage) Get the property value as type String from the given 'Properties Configuration' by the given property name.
static Optional<String>	getStringProperty(com.sdl.delivery.configuration.Configuration propertiesConfig, String propertyName) Get the property value as type String from the given 'Properties Configuration' by the given property name.
static Optional<com.sdl.delivery.configuration.Value>	getValueProperty(com.sdl.delivery.configuration.Configuration propertyConfig) Get the property value configuration value from the given 'Property configuration' (of type <Property Name="X" Value="Y" /> in case it is represented as XML).
static Optional<com.sdl.delivery.configuration.Value>	getValueProperty(com.sdl.delivery.configuration.Configuration propertiesConfig, String propertyName) Get the property value from the given 'Properties configuration' (of type <Properties>...</Properties> in case it is represented as XML) and property name.
static <T> Stream<T>	optionalToStream(Optional<T> optional) Convert an optional to a stream.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_VALUE_PROPERTY_NAME

public static final String CONFIG_VALUE_PROPERTY_NAME

Configuration Value used to specify a 'Property Name'.

See Also:

Constant Field Values

CONFIG_VALUE_PROPERTY_VALUE

public static final String CONFIG_VALUE_PROPERTY_VALUE

Configuration Value used to specify a 'Property Value'.

See Also:

Constant Field Values

Constructor Detail

ConfigurationPropertyUtils

public ConfigurationPropertyUtils()

Method Detail

getNonEmptyStringProperty

public static String getNonEmptyStringProperty(com.sdl.delivery.configuration.Configuration propertiesConfig,
                                               String propertyName,
                                               String errorMessage)
                                        throws com.sdl.delivery.configuration.ConfigurationException

Get the property value as type String from the given 'Properties Configuration' by the given property 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 nor empty.

Parameters:

propertiesConfig - The given 'Properties Configuration'. It can not be null.

propertyName - The given property name. It can not be null, neither empty.

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

Throws:

com.sdl.delivery.configuration.ConfigurationException - In case the value can not be found or it is empty.

getStringProperty

public static Optional<String> getStringProperty(com.sdl.delivery.configuration.Configuration propertiesConfig,
                                                 String propertyName)

Get the property value as type String from the given 'Properties Configuration' by the given property name.

Parameters:

propertiesConfig - The given 'Properties Configuration'. It can not be null.

propertyName - The given property name. It can not be null, neither empty.

Returns:

The property value as an option.

getLongProperty

public static Optional<Long> getLongProperty(com.sdl.delivery.configuration.Configuration propertiesConfig,
                                             String propertyName)

Get the property value as type Long from the given 'Properties Configuration' by the given property name.

Parameters:

propertiesConfig - The given 'Properties Configuration'. It can not be null.

propertyName - The given property name. It can not be null, neither empty.

Returns:

The property value as an option.

getBigIntegerProperty

public static Optional<BigInteger> getBigIntegerProperty(com.sdl.delivery.configuration.Configuration propertiesConfig,
                                                         String propertyName)

Get the property value as type BigInteger from the given 'Properties Configuration' by the given property name.

Parameters:

propertiesConfig - The given 'Properties Configuration'. It can not be null.

propertyName - The given property name. It can not be null, neither empty.

Returns:

The property value as an option.

getDoubleProperty

public static Optional<Double> getDoubleProperty(com.sdl.delivery.configuration.Configuration propertiesConfig,
                                                 String propertyName)

Get the property value as type Double from the given 'Properties Configuration' by the given property name.

Parameters:

propertiesConfig - The given 'Properties Configuration'. It can not be null.

propertyName - The given property name. It can not be null, neither empty.

Returns:

The property value as an option.

getBigDecimalProperty

public static Optional<BigDecimal> getBigDecimalProperty(com.sdl.delivery.configuration.Configuration propertiesConfig,
                                                         String propertyName)

Get the property value as type BigDecimal from the given 'Properties Configuration' by the given property name.

Parameters:

propertiesConfig - The given 'Properties Configuration'. It can not be null.

propertyName - The given property name. It can not be null, neither empty.

Returns:

The property value as an option.

getBooleanProperty

public static Optional<Boolean> getBooleanProperty(com.sdl.delivery.configuration.Configuration propertiesConfig,
                                                   String propertyName)

Get the property value as type Boolean from the given 'Properties Configuration' by the given property name.

Parameters:

propertiesConfig - The given 'Properties Configuration'. It can not be null.

propertyName - The given property name. It can not be null, neither empty.

Returns:

The property value as an option.

getDateProperty

public static Optional<Calendar> getDateProperty(com.sdl.delivery.configuration.Configuration propertiesConfig,
                                                 String propertyName)

Get the property value as type Calendar from the given 'Properties Configuration' by the given property name.

Parameters:

propertiesConfig - The given 'Properties Configuration'. It can not be null.

propertyName - The given property name. It can not be null, neither empty.

Returns:

The property value as an option.

getValueProperty

public static Optional<com.sdl.delivery.configuration.Value> getValueProperty(com.sdl.delivery.configuration.Configuration propertiesConfig,
                                                                              String propertyName)

Get the property value from the given 'Properties configuration' (of type <Properties>...</Properties> in case it is represented as XML) and property name.

Parameters:

propertiesConfig - The given 'Properties configuration'. It can not be null.

propertyName - The given property name. It can not be null neither empty.

Returns:

The value as an option.

getNameProperty

public static Optional<com.sdl.delivery.configuration.Value> getNameProperty(com.sdl.delivery.configuration.Configuration propertyConfig)

Get the property name configuration value from the given 'Property configuration' (of type <Property Name="X" Value="Y" /> in case it is represented as XML).

Parameters:

propertyConfig - The given 'Property configuration'. It can not be null.

Returns:

The property name configuration value as an option.

getValueProperty

public static Optional<com.sdl.delivery.configuration.Value> getValueProperty(com.sdl.delivery.configuration.Configuration propertyConfig)

Get the property value configuration value from the given 'Property configuration' (of type <Property Name="X" Value="Y" /> in case it is represented as XML).

Parameters:

propertyConfig - The given 'Property configuration'. It can not be null.

Returns:

The property value configuration value as an option.

optionalToStream

public static <T> Stream<T> optionalToStream(Optional<T> optional)

Convert an optional to a stream.

Type Parameters:

T - The type contained by the source optional.

Parameters:

optional - The optional to convert. It can not be null.

Returns:

The converted stream.

getConfigurationAsStringValues

public static Optional<Map<String,String>> getConfigurationAsStringValues(Map<String,com.sdl.delivery.configuration.Value> configValuesMap)

Converts a Map containing configuration values ( Map) to Map.

Parameters:

configValuesMap - Map containing configuration values.

Returns:

The converted Map.