net.obvj.confectory.helper

Class BeanConfigurationHelper<T>

java.lang.Object

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

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

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

Type Parameters:

T - the configuration bean type

All Implemented Interfaces:

ConfigurationDataRetriever<T>, ConfigurationHelper<T>

public class BeanConfigurationHelper<T>
extends BasicConfigurationHelper<T>

A Configuration Helper implementation for user-defined beans.

Since:

0.1.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Constructor Summary

Constructors

Constructor and Description
BeanConfigurationHelper(T source) Builds a new Configuration Helper instance with a specific source.

Method Summary

Modifier and Type	Method and Description
String	getMandatoryString(String key) Returns the String value associated with the specified key.
String	getString(String key) Returns the String value associated with the specified key.

Methods inherited from class net.obvj.confectory.helper.BasicConfigurationHelper

getBean, getBoolean, getDouble, getInt, getLong, getMandatoryBoolean, getMandatoryDouble, getMandatoryInt, getMandatoryLong

Methods inherited from class net.obvj.confectory.helper.AbstractBasicConfigurationHelper

getNullValueProvider, setNullValueProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanConfigurationHelper

public BeanConfigurationHelper(T source)

Builds a new Configuration Helper instance with a specific source.

Parameters:

source - the source bean, mainly for exception/reporting purposes

Method Detail

getString

public String getString(String key)

Description copied from interface: ConfigurationDataRetriever

Returns the String value associated with the specified key.

Parameters:

key - not used since this method implementation is a "no-op"

Returns:

the String value associated with the specified key

Throws:

ConfigurationException - always, since the data for this type of helper should be handled by the user-defined bean

getMandatoryString

public String getMandatoryString(String key)

Description copied from interface: ConfigurationDataRetriever

Returns the String value associated with the specified key.

Parameters:

key - not used since this method implementation is a "no-op"

Returns:

the String value associated with the specified key

Throws:

ConfigurationException - always, since the data for this type of helper should be handled by the user-defined bean