Package io.confound.config

Class AbstractStringConfiguration

java.lang.Object

io.confound.config.AbstractConfiguration

io.confound.config.BaseConfiguration

io.confound.config.AbstractStringConfiguration

All Implemented Interfaces:

Configuration, Parameters

Direct Known Subclasses:

StringMapConfiguration

public abstract class AbstractStringConfiguration
extends BaseConfiguration

Abstract configuration implementation for which the underlying storage is based solely on strings.

This class retrieves all parameters as stored in string format based upon BaseConfiguration.getOptionalStringImpl(String).

Author:

Garret Wilson

Constructor Summary

Constructors

Constructor	Description
AbstractStringConfiguration(Optional<Configuration> parentConfiguration)	Parent configuration constructor.

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	getOptionalBoolean(String key)	Retrieves a Boolean parameter that may not be present.
Optional<Double>	getOptionalDouble(String key)	Retrieves a floating point parameter that may not be present.
Optional<Integer>	getOptionalInt(String key)	Retrieves an integer parameter that may not be present.
Optional<Long>	getOptionalLong(String key)	Retrieves a long integer parameter that may not be present.
<T> Optional<T>	getOptionalParameter(String key)	Retrieves a general parameter that may not be present.
Optional<Path>	getOptionalPath(String key)	Retrieves a path parameter that may not be present.
Optional<URI>	getOptionalUri(String key)	Retrieves a URI parameter that may not be present.
boolean	hasParameter(String key)	Determines whether a parameter of some type exists for the given parameter key.

Methods inherited from class io.confound.config.AbstractConfiguration

getParentConfiguration, or

Methods inherited from class io.confound.config.BaseConfiguration

dereferenceString, getOptionalDereferencedString, getOptionalString, getOptionalStringImpl, normalizeKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.confound.config.Parameters

getBoolean, getDouble, getInt, getLong, getParameter, getPath, getString, getUri, requireParameter, resolvePath

Constructor Detail

AbstractStringConfiguration

public AbstractStringConfiguration(@Nonnull
                                   Optional<Configuration> parentConfiguration)

Parent configuration constructor.

Parameters:

parentConfiguration - The parent configuration for fallback lookup.

Throws:

NullPointerException - if the given parent configuration is null.

Method Detail

hasParameter

public boolean hasParameter(@Nonnull
                            String key)
                     throws ConfigurationException

Determines whether a parameter of some type exists for the given parameter key.

This method searches the parent configuration hierarchy if no parameter is available in this instance.

This implementation delegates to BaseConfiguration.getOptionalStringImpl(String).

Parameters:

key - The parameter key.

Returns:

true if a parameter of type type could be retrieved from these parameters using the given key.

Throws:

ConfigurationException - if there is a parameter value stored in an invalid format.

getOptionalParameter

public <T> Optional<T> getOptionalParameter(String key)
                                     throws ConfigurationException

Retrieves a general parameter that may not be present.

This implementation delegates to BaseConfiguration.getOptionalDereferencedString(String).

Type Parameters:

T - The type of parameter expected.

Parameters:

key - The parameter key.

Returns:

The optional value of the parameter associated with the given key.

Throws:

ConfigurationException - if there is a parameter value stored in an invalid format.

getOptionalBoolean

public Optional<Boolean> getOptionalBoolean(String key)
                                     throws ConfigurationException

Retrieves a Boolean parameter that may not be present.

This implementation parses the value using Boolean.valueOf(String).

Parameters:

key - The parameter key.

Returns:

The optional value of the parameter associated with the given key.

Throws:

ConfigurationException - if there is a parameter value stored in an invalid format.

getOptionalDouble

public Optional<Double> getOptionalDouble(String key)
                                   throws ConfigurationException

Retrieves a floating point parameter that may not be present.

This implementation parses the value using Double.valueOf(String).

Parameters:

key - The parameter key.

Returns:

The optional value of the parameter associated with the given key.

Throws:

ConfigurationException - if there is a parameter value stored in an invalid format.

getOptionalInt

public Optional<Integer> getOptionalInt(String key)
                                 throws ConfigurationException

Retrieves an integer parameter that may not be present.

This implementation parses the value using Integer.valueOf(String).

Parameters:

key - The parameter key.

Returns:

The optional value of the parameter associated with the given key.

Throws:

ConfigurationException - if there is a parameter value stored in an invalid format.

getOptionalLong

public Optional<Long> getOptionalLong(String key)
                               throws ConfigurationException

Retrieves a long integer parameter that may not be present.

The default implementation delegates to Parameters.getOptionalInt(String).

This implementation parses the value using Long.valueOf(long).

Parameters:

key - The parameter key.

Returns:

The optional value of the parameter associated with the given key.

Throws:

ConfigurationException - if there is a parameter value stored in an invalid format.

getOptionalPath

public Optional<Path> getOptionalPath(String key)
                               throws ConfigurationException

Retrieves a path parameter that may not be present.

The path will be resolved using Parameters.resolvePath(Path).

This implementation parses the value using URI.create(String) and then resolves the path using Parameters.resolvePath(Path).

Parameters:

key - The parameter key.

Returns:

The optional value of the parameter associated with the given key.

Throws:

ConfigurationException - if there is a parameter value stored in an invalid format.

getOptionalUri

public Optional<URI> getOptionalUri(String key)
                             throws ConfigurationException

Retrieves a URI parameter that may not be present.

This implementation parses the value using URI.create(String).

Parameters:

key - The parameter key.

Returns:

The optional value of the parameter associated with the given key.

Throws:

ConfigurationException - if there is a parameter value stored in an invalid format.