net.obvj.confectory.helper

Class BasicConfigurationHelper<T>

java.lang.Object

net.obvj.confectory.helper.BasicConfigurationHelper<T>

Type Parameters:

T - the source type which configuration data is to be retrieved

All Implemented Interfaces:

ConfigurationDataRetriever<T>, ConfigurationHelper<T>

Direct Known Subclasses:

BeanConfigurationHelper, PropertiesConfigurationHelper

public abstract class BasicConfigurationHelper<T>
extends Object
implements ConfigurationHelper<T>

A basic, abstract Configuration Helper object providing common infrastructure for concrete implementations.

Since:

0.1.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Method Summary

Modifier and Type	Method and Description
T	getBean() Returns the configuration bean used by this data retriever, typically for manual handling and/or troubleshooting purposes.
Boolean	getBoolean(String key) Returns the Boolean object associated with the specified key.
Double	getDouble(String key) Returns the Double object associated with the specified key.
Integer	getInteger(String key) Returns the Integer object associated with the specified key.
Long	getLong(String key) Returns the Long object associated with the specified key.
Boolean	getMandatoryBoolean(String key) Returns the Boolean object associated with the specified key, throwing an exception if not found.
Double	getMandatoryDouble(String key) Returns the Double object associated with the specified key, throwing an exception if not found.
Integer	getMandatoryInteger(String key) Returns the Integer object associated with the specified key, throwing an exception if not found.
Long	getMandatoryLong(String key) Returns the Long object associated with the specified key, throwing an exception if not found.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.obvj.confectory.ConfigurationDataRetriever

getMandatoryString, getString

Method Detail

getBean

public T getBean()

Description copied from interface: ConfigurationDataRetriever

Returns the configuration bean used by this data retriever, typically for manual handling and/or troubleshooting purposes.

Specified by:

getBean in interface ConfigurationDataRetriever<T>

Returns:

the configuration bean (Note: it can be null if the Configuration is marked as optional)

getBoolean

public Boolean getBoolean(String key)

Description copied from interface: ConfigurationDataRetriever

Returns the Boolean object associated with the specified key.

Specified by:

getBoolean in interface ConfigurationDataRetriever<T>

Parameters:

key - the object key (some implementations may also accept a path expression, e.g: JSONPath)

Returns:

the Boolean object associated with the specified key; null if not found

getMandatoryBoolean

public Boolean getMandatoryBoolean(String key)

Description copied from interface: ConfigurationDataRetriever

Returns the Boolean object associated with the specified key, throwing an exception if not found.

Specified by:

getMandatoryBoolean in interface ConfigurationDataRetriever<T>

Parameters:

key - the object key (some implementations may also accept a path expression, e.g: JSONPath)

Returns:

the Boolean value associated with the specified key; never null

getInteger

public Integer getInteger(String key)

Description copied from interface: ConfigurationDataRetriever

Returns the Integer object associated with the specified key.

Specified by:

getInteger in interface ConfigurationDataRetriever<T>

Parameters:

key - the object key (some implementations may also accept a path expression, e.g: JSONPath

Returns:

the Integer object associated with the specified key; null if not found

getMandatoryInteger

public Integer getMandatoryInteger(String key)

Description copied from interface: ConfigurationDataRetriever

Returns the Integer object associated with the specified key, throwing an exception if not found.

Specified by:

getMandatoryInteger in interface ConfigurationDataRetriever<T>

Parameters:

key - the object key (some implementations may also accept a path expression, e.g: JSONPath)

Returns:

the Integer object associated with the specified key; never null

getLong

public Long getLong(String key)

Description copied from interface: ConfigurationDataRetriever

Returns the Long object associated with the specified key.

Specified by:

getLong in interface ConfigurationDataRetriever<T>

Parameters:

key - the object key (some implementations may also accept a path expression, e.g: JSONPath

Returns:

the Long object associated with the specified key; null if not found

getMandatoryLong

public Long getMandatoryLong(String key)

Description copied from interface: ConfigurationDataRetriever

Returns the Long object associated with the specified key, throwing an exception if not found.

Specified by:

getMandatoryLong in interface ConfigurationDataRetriever<T>

Parameters:

key - the object key (some implementations may also accept a path expression, e.g: JSONPath)

Returns:

the Long object associated with the specified key; never null

getDouble

public Double getDouble(String key)

Description copied from interface: ConfigurationDataRetriever

Returns the Double object associated with the specified key.

Specified by:

getDouble in interface ConfigurationDataRetriever<T>

Parameters:

key - the object key (some implementations may also accept a path expression, e.g: JSONPath

Returns:

the Double object associated with the specified key; null if not found

getMandatoryDouble

public Double getMandatoryDouble(String key)

Description copied from interface: ConfigurationDataRetriever

Returns the Double object associated with the specified key, throwing an exception if not found.

Specified by:

getMandatoryDouble in interface ConfigurationDataRetriever<T>

Parameters:

key - the object key (some implementations may also accept a path expression, e.g: JSONPath)

Returns:

the Double object associated with the specified key; never null