Package net.obvj.confectory.internal.helper

Class PropertiesConfigurationHelper

java.lang.Object

net.obvj.confectory.internal.helper.BasicConfigurationHelper<Properties>

net.obvj.confectory.internal.helper.PropertiesConfigurationHelper

All Implemented Interfaces:

ConfigurationDataRetriever<Properties>, ConfigurationHelper<Properties>

public class PropertiesConfigurationHelper
extends BasicConfigurationHelper<Properties>

A specialized Configuration Helper that retrieves data from a Properties object.

Since:

0.1.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Constructor Summary

Constructors

Constructor	Description
PropertiesConfigurationHelper(Properties properties)	Builds a new dedicated instance from a specific Properties object.

Method Summary

Modifier and Type	Method	Description
ConfigurationMerger<Properties>	configurationMerger()	Creates the applicable ConfigurationMerger object for the type associated with this ConfigurationHelper.
Object	get(String key)	Returns the object associated with the specified key.
String	getAsString()	Returns a string representation of the bean used by this data retriever, typically for manual handling and/or troubleshooting purposes.
String	getMandatoryString(String key)	Returns the String object associated with the specified key, throwing an exception if not found.
String	getString(String key)	Returns the String object associated with the specified key.

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

getBean, getBoolean, getDouble, getInteger, getLong, getMandatoryBoolean, getMandatoryDouble, getMandatoryInteger, getMandatoryLong

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesConfigurationHelper

public PropertiesConfigurationHelper(Properties properties)

Builds a new dedicated instance from a specific Properties object.

Parameters:

properties - the Properties to be maintained by this helper

Method Detail

getAsString

public String getAsString()

Description copied from interface: ConfigurationDataRetriever

Returns a string representation of the bean used by this data retriever, typically for manual handling and/or troubleshooting purposes.

Returns:

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

get

public Object get(String key)

Description copied from interface: ConfigurationDataRetriever

Returns the object associated with the specified key.

Notes:

• The actual return type may vary depending on the underlying implementation
• On a JSON implementation, the return will usually be an array

Parameters:

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

Returns:

the object object associated with the specified key. Depending on the actual implementation, the result may be either null or an empty array if the specified key is not found

getString

public String getString(String key)

Description copied from interface: ConfigurationDataRetriever

Returns the String object associated with the specified key.

Parameters:

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

Returns:

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

getMandatoryString

public String getMandatoryString(String key)

Description copied from interface: ConfigurationDataRetriever

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

Parameters:

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

Returns:

the String object associated with the specified key; never null

configurationMerger

public ConfigurationMerger<Properties> configurationMerger()

Description copied from interface: ConfigurationHelper

Creates the applicable ConfigurationMerger object for the type associated with this ConfigurationHelper.

Returns:

a new ConfigurationMerger instance