org.finra.herd.core.helper

Class ConfigurationHelper

java.lang.Object

org.finra.herd.core.helper.ConfigurationHelper

@Component
public class ConfigurationHelper
extends Object

A helper for ConfigurationValue. Mainly used to facilitate access to current application's Environment object.

Constructor Summary

Constructors

Constructor and Description
ConfigurationHelper()

Method Summary

Modifier and Type	Method and Description
Boolean	getBooleanProperty(ConfigurationValue configurationValue) Gets a property value as a boolean.
Boolean	getBooleanProperty(ConfigurationValue configurationValue, org.springframework.core.env.Environment environment) Gets a property value as a boolean.
String	getProperty(ConfigurationValue configurationValue) Calls getProperty(ConfigurationValue, Class) where the target type is String.
<T> T	getProperty(ConfigurationValue configurationValue, Class<T> targetType) Calls getProperty(ConfigurationValue, Class, Environment)
static <T> T	getProperty(ConfigurationValue configurationValue, Class<T> targetType, org.springframework.core.env.Environment environment) Wrapper for PropertyResolver.getProperty(String, Class, Object) using the given ConfigurationValue as the key and default value.
static String	getProperty(ConfigurationValue configurationValue, org.springframework.core.env.Environment environment) Calls getProperty(ConfigurationValue, Class, Environment) using String targetType.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationHelper

public ConfigurationHelper()

Method Detail

getProperty

public static String getProperty(ConfigurationValue configurationValue,
                                 org.springframework.core.env.Environment environment)

Calls getProperty(ConfigurationValue, Class, Environment) using String targetType.

Parameters:

configurationValue - ConfigurationValue

environment - Environment

Returns:

String value

getProperty

public static <T> T getProperty(ConfigurationValue configurationValue,
                                Class<T> targetType,
                                org.springframework.core.env.Environment environment)

Wrapper for PropertyResolver.getProperty(String, Class, Object) using the given ConfigurationValue as the key and default value. Optionally, uses the configured default value if the property is not found in the environment. The configured default value must be of the same class, or must be a sub-class of the given targetType.

Type Parameters:

T - The return type

Parameters:

configurationValue - The ConfigurationValue with property key and default value.

targetType - The returned object's type

environment - The Environment containing the property

Returns:

The property value

getProperty

public String getProperty(ConfigurationValue configurationValue)

Calls getProperty(ConfigurationValue, Class) where the target type is String.

Parameters:

configurationValue - ConfigurationValue

Returns:

The string value

getProperty

public <T> T getProperty(ConfigurationValue configurationValue,
                         Class<T> targetType)

Calls getProperty(ConfigurationValue, Class, Environment)

Parameters:

configurationValue - The ConfigurationValue

targetType - The return type

Returns:

The property value

getBooleanProperty

public Boolean getBooleanProperty(ConfigurationValue configurationValue)

Gets a property value as a boolean.

Parameters:

configurationValue - the boolean configuration value

Returns:

the boolean property value

getBooleanProperty

public Boolean getBooleanProperty(ConfigurationValue configurationValue,
                                  org.springframework.core.env.Environment environment)

Gets a property value as a boolean.

Parameters:

configurationValue - the boolean configuration value

environment - the environment containing the property

Returns:

the boolean property value