Package com.arpnetworking.configuration

Class BaseConfiguration

java.lang.Object

com.arpnetworking.configuration.BaseConfiguration

All Implemented Interfaces:

Configuration

Direct Known Subclasses:

BaseJacksonConfiguration

public abstract class BaseConfiguration
extends Object
implements Configuration

Abstract base class for Configuration implementations which implements the shared convenience methods which rely core methods. The core methods are left for implementation by each concrete subclass.

Author:

Ville Koskela (ville dot koskela at inscopemetrics dot io)

Constructor Summary

Constructors

Constructor	Description
BaseConfiguration()

Method Summary

Modifier and Type	Method	Description
<T> T	getAs(Class<? extends T> clazz, T defaultValue)	Generic object accessor.
<T> T	getAs(Type type, T defaultValue)	Generic object accessor.
String	getProperty(String name, String defaultValue)	Retrieve the value of a particular property by its name and if it does not exist return the specified default.
<T> T	getPropertyAs(String name, Class<? extends T> clazz, T defaultValue)	Generic object accessor.
<T> T	getPropertyAs(String name, Type type, T defaultValue)	Generic object accessor.
Optional<Boolean>	getPropertyAsBoolean(String name)	Boolean specific accessor.
boolean	getPropertyAsBoolean(String name, boolean defaultValue)	Boolean specific accessor.
Optional<Double>	getPropertyAsDouble(String name)	Double specific accessor.
double	getPropertyAsDouble(String name, double defaultValue)	Double specific accessor.
Optional<Float>	getPropertyAsFloat(String name)	Float specific accessor.
float	getPropertyAsFloat(String name, float defaultValue)	Float specific accessor.
Optional<Integer>	getPropertyAsInteger(String name)	Integer specific accessor.
int	getPropertyAsInteger(String name, int defaultValue)	Integer specific accessor.
Optional<Long>	getPropertyAsLong(String name)	Long specific accessor.
long	getPropertyAsLong(String name, long defaultValue)	Long specific accessor.
Optional<Short>	getPropertyAsShort(String name)	Short specific accessor.
short	getPropertyAsShort(String name, short defaultValue)	Short specific accessor.
<T> T	getRequiredAs(Class<? extends T> clazz)	Generic object accessor.
<T> T	getRequiredAs(Type type)	Generic object accessor.
String	getRequiredProperty(String name)	Retrieve the value of a particular property by its name and if it does not exist throw a RuntimeException.
<T> T	getRequiredPropertyAs(String name, Class<? extends T> clazz)	Generic object accessor.
<T> T	getRequiredPropertyAs(String name, Type type)	Generic object accessor.
boolean	getRequiredPropertyAsBoolean(String name)	Boolean specific accessor.
double	getRequiredPropertyAsDouble(String name)	Double specific accessor.
float	getRequiredPropertyAsFloat(String name)	Float specific accessor.
int	getRequiredPropertyAsInteger(String name)	Integer specific accessor.
long	getRequiredPropertyAsLong(String name)	Long specific accessor.
short	getRequiredPropertyAsShort(String name)	Short specific accessor.
Object	toLogValue()	Generate a Steno log compatible representation.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.arpnetworking.configuration.Configuration

getAs, getAs, getProperty, getPropertyAs, getPropertyAs

Constructor Details

BaseConfiguration

public BaseConfiguration()

Method Details

getProperty

public String getProperty(String name,
 String defaultValue)

Description copied from interface: Configuration

Retrieve the value of a particular property by its name and if it does not exist return the specified default.

Specified by:

getProperty in interface Configuration

Parameters:

name - The name of the property value to retrieve.

defaultValue - The value to return if the specified property name does not exist in the configuration.

Returns:

Returns the property value or defaultValue if the property name has not been defined.

getRequiredProperty

public String getRequiredProperty(String name)
                           throws NoSuchElementException

Description copied from interface: Configuration

Retrieve the value of a particular property by its name and if it does not exist throw a RuntimeException.

Specified by:

getRequiredProperty in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value.

Throws:

NoSuchElementException - throws the RuntimeException if the specified property name is not defined.

getPropertyAsBoolean

public Optional<Boolean> getPropertyAsBoolean(String name)

Description copied from interface: Configuration

Boolean specific accessor. Anything other than "true", ignoring case, is treated as false.

Specified by:

getPropertyAsBoolean in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

See Also:

• Configuration.getProperty(String)

getPropertyAsBoolean

public boolean getPropertyAsBoolean(String name,
 boolean defaultValue)

Description copied from interface: Configuration

Boolean specific accessor. Anything other than "true", ignoring case, is treated as false.

Specified by:

getPropertyAsBoolean in interface Configuration

Parameters:

name - The name of the property value to retrieve.

defaultValue - The value to return if the specified property name does not exist in the configuration.

Returns:

Returns the property value or defaultValue if the property name has not been defined.

See Also:

• Configuration.getProperty(String, String)

getRequiredPropertyAsBoolean

public boolean getRequiredPropertyAsBoolean(String name)
                                     throws NoSuchElementException

Description copied from interface: Configuration

Boolean specific accessor. Anything other than "true", ignoring case, is treated as false.

Specified by:

getRequiredPropertyAsBoolean in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value.

Throws:

NoSuchElementException - throws the RuntimeException if the specified property name is not defined.

See Also:

• Configuration.getRequiredProperty(String)

getPropertyAsInteger

public Optional<Integer> getPropertyAsInteger(String name)
                                       throws NumberFormatException

Description copied from interface: Configuration

Integer specific accessor.

Specified by:

getPropertyAsInteger in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

Throws:

NumberFormatException - if the value cannot be converted to an Integer.

See Also:

• Configuration.getProperty(String)

getPropertyAsInteger

public int getPropertyAsInteger(String name,
 int defaultValue)
                         throws NumberFormatException

Description copied from interface: Configuration

Integer specific accessor.

Specified by:

getPropertyAsInteger in interface Configuration

Parameters:

name - The name of the property value to retrieve.

defaultValue - The value to return if the specified property name does not exist in the configuration.

Returns:

Returns the property value or defaultValue if the property name has not been defined.

Throws:

NumberFormatException - if the value cannot be converted to an Integer.

See Also:

• Configuration.getProperty(String, String)

getRequiredPropertyAsInteger

public int getRequiredPropertyAsInteger(String name)
                                 throws NoSuchElementException,
NumberFormatException

Description copied from interface: Configuration

Integer specific accessor.

Specified by:

getRequiredPropertyAsInteger in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value.

Throws:

NoSuchElementException - throws the RuntimeException if the specified property name is not defined.

NumberFormatException - if the value cannot be converted to an Integer.

See Also:

• Configuration.getRequiredProperty(String)

getPropertyAsLong

public Optional<Long> getPropertyAsLong(String name)
                                 throws NumberFormatException

Description copied from interface: Configuration

Long specific accessor.

Specified by:

getPropertyAsLong in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

Throws:

NumberFormatException - if the value cannot be converted to a Long.

See Also:

• Configuration.getProperty(String)

getPropertyAsLong

public long getPropertyAsLong(String name,
 long defaultValue)
                       throws NumberFormatException

Description copied from interface: Configuration

Long specific accessor.

Specified by:

getPropertyAsLong in interface Configuration

Parameters:

name - The name of the property value to retrieve.

defaultValue - The value to return if the specified property name does not exist in the configuration.

Returns:

Returns the property value or defaultValue if the property name has not been defined.

Throws:

NumberFormatException - if the value cannot be converted to a Long.

See Also:

• Configuration.getProperty(String, String)

getRequiredPropertyAsLong

public long getRequiredPropertyAsLong(String name)
                               throws NoSuchElementException,
NumberFormatException

Description copied from interface: Configuration

Long specific accessor.

Specified by:

getRequiredPropertyAsLong in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value.

Throws:

NoSuchElementException - throws the RuntimeException if the specified property name is not defined.

NumberFormatException - if the value cannot be converted to a Long.

See Also:

• Configuration.getRequiredProperty(String)

getPropertyAsDouble

public Optional<Double> getPropertyAsDouble(String name)
                                     throws NumberFormatException

Description copied from interface: Configuration

Double specific accessor.

Specified by:

getPropertyAsDouble in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

Throws:

NumberFormatException - if the value cannot be converted to a Double.

See Also:

• Configuration.getProperty(String)

getPropertyAsDouble

public double getPropertyAsDouble(String name,
 double defaultValue)
                           throws NumberFormatException

Description copied from interface: Configuration

Double specific accessor.

Specified by:

getPropertyAsDouble in interface Configuration

Parameters:

name - The name of the property value to retrieve.

defaultValue - The value to return if the specified property name does not exist in the configuration.

Returns:

Returns the property value or defaultValue if the property name has not been defined.

Throws:

NumberFormatException - if the value cannot be converted to a Double.

See Also:

• Configuration.getProperty(String, String)

getRequiredPropertyAsDouble

public double getRequiredPropertyAsDouble(String name)
                                   throws NoSuchElementException,
NumberFormatException

Description copied from interface: Configuration

Double specific accessor.

Specified by:

getRequiredPropertyAsDouble in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value.

Throws:

NoSuchElementException - throws the RuntimeException if the specified property name is not defined.

NumberFormatException - if the value cannot be converted to a Double.

See Also:

• Configuration.getRequiredProperty(String)

getPropertyAsFloat

public Optional<Float> getPropertyAsFloat(String name)
                                   throws NumberFormatException

Description copied from interface: Configuration

Float specific accessor.

Specified by:

getPropertyAsFloat in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

Throws:

NumberFormatException - if the value cannot be converted to a Float.

See Also:

• Configuration.getProperty(String)

getPropertyAsFloat

public float getPropertyAsFloat(String name,
 float defaultValue)
                         throws NumberFormatException

Description copied from interface: Configuration

Float specific accessor.

Specified by:

getPropertyAsFloat in interface Configuration

Parameters:

name - The name of the property value to retrieve.

defaultValue - The value to return if the specified property name does not exist in the configuration.

Returns:

Returns the property value or defaultValue if the property name has not been defined.

Throws:

NumberFormatException - if the value cannot be converted to a Float.

See Also:

• Configuration.getProperty(String, String)

getRequiredPropertyAsFloat

public float getRequiredPropertyAsFloat(String name)
                                 throws NoSuchElementException,
NumberFormatException

Description copied from interface: Configuration

Float specific accessor.

Specified by:

getRequiredPropertyAsFloat in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value.

Throws:

NoSuchElementException - throws the RuntimeException if the specified property name is not defined.

NumberFormatException - if the value cannot be converted to a Float.

See Also:

• Configuration.getRequiredProperty(String)

getPropertyAsShort

public Optional<Short> getPropertyAsShort(String name)
                                   throws NumberFormatException

Description copied from interface: Configuration

Short specific accessor.

Specified by:

getPropertyAsShort in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

Throws:

NumberFormatException - if the value cannot be converted to a Short.

See Also:

• Configuration.getProperty(String)

getPropertyAsShort

public short getPropertyAsShort(String name,
 short defaultValue)
                         throws NumberFormatException

Description copied from interface: Configuration

Short specific accessor.

Specified by:

getPropertyAsShort in interface Configuration

Parameters:

name - The name of the property value to retrieve.

defaultValue - The value to return if the specified property name does not exist in the configuration.

Returns:

Returns the property value or defaultValue if the property name has not been defined.

Throws:

NumberFormatException - if the value cannot be converted to a Short.

See Also:

• Configuration.getProperty(String, String)

getRequiredPropertyAsShort

public short getRequiredPropertyAsShort(String name)
                                 throws NoSuchElementException,
NumberFormatException

Description copied from interface: Configuration

Short specific accessor.

Specified by:

getRequiredPropertyAsShort in interface Configuration

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value.

Throws:

NoSuchElementException - throws the RuntimeException if the specified property name is not defined.

NumberFormatException - if the value cannot be converted to a Short.

See Also:

• Configuration.getRequiredProperty(String)

getPropertyAs

public <T> T getPropertyAs(String name,
 Class<? extends T> clazz,
 T defaultValue)
                    throws IllegalArgumentException

Description copied from interface: Configuration

Generic object accessor.

Specified by:

getPropertyAs in interface Configuration

Type Parameters:

T - The type to return.

Parameters:

name - The name of the property value to retrieve.

clazz - The type of the object to instantiate.

defaultValue - The value to return if the specified property name does not exist in the configuration.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

Throws:

IllegalArgumentException - if the value cannot be converted to an instance of T.

getRequiredPropertyAs

public <T> T getRequiredPropertyAs(String name,
 Class<? extends T> clazz)
                            throws NoSuchElementException,
IllegalArgumentException

Description copied from interface: Configuration

Generic object accessor.

Specified by:

getRequiredPropertyAs in interface Configuration

Type Parameters:

T - The type to return.

Parameters:

name - The name of the property value to retrieve.

clazz - The type of the object to instantiate.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

Throws:

NoSuchElementException - throws the RuntimeException if the specified property name is not defined.

IllegalArgumentException - if the value cannot be converted to an instance of Configuration.

getAs

public <T> T getAs(Class<? extends T> clazz,
 T defaultValue)
            throws IllegalArgumentException

Description copied from interface: Configuration

Generic object accessor.

Specified by:

getAs in interface Configuration

Type Parameters:

T - The type to return.

Parameters:

clazz - The type of the object to instantiate.

defaultValue - The value to return if the specified property name does not exist in the configuration.

Returns:

Returns the entire configuration as an instance of T.

Throws:

IllegalArgumentException - if the value cannot be converted to an instance of T.

See Also:

• Configuration.getProperty(String)

getRequiredAs

public <T> T getRequiredAs(Class<? extends T> clazz)
                    throws NoSuchElementException,
IllegalArgumentException

Description copied from interface: Configuration

Generic object accessor.

Specified by:

getRequiredAs in interface Configuration

Type Parameters:

T - The type to return.

Parameters:

clazz - The type of the object to instantiate.

Returns:

Returns the entire configuration as an instance of T.

Throws:

NoSuchElementException - throws the RuntimeException if the configuration is not available.

IllegalArgumentException - if the value cannot be converted to an instance of T.

getPropertyAs

public <T> T getPropertyAs(String name,
 Type type,
 T defaultValue)
                    throws IllegalArgumentException

Description copied from interface: Configuration

Generic object accessor.

Specified by:

getPropertyAs in interface Configuration

Type Parameters:

T - The type to return.

Parameters:

name - The name of the property value to retrieve.

type - The type of the object to instantiate.

defaultValue - The value to return if the specified property name does not exist in the configuration.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

Throws:

IllegalArgumentException - if the value cannot be converted to an instance of T.

getRequiredPropertyAs

public <T> T getRequiredPropertyAs(String name,
 Type type)
                            throws NoSuchElementException,
IllegalArgumentException

Description copied from interface: Configuration

Generic object accessor.

Specified by:

getRequiredPropertyAs in interface Configuration

Type Parameters:

T - The type to return.

Parameters:

name - The name of the property value to retrieve.

type - The type of the object to instantiate.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

Throws:

NoSuchElementException - throws the RuntimeException if the specified property name is not defined.

IllegalArgumentException - if the value cannot be converted to an instance of T.

getAs

public <T> T getAs(Type type,
 T defaultValue)
            throws IllegalArgumentException

Description copied from interface: Configuration

Generic object accessor.

Specified by:

getAs in interface Configuration

Type Parameters:

T - The type to return.

Parameters:

type - The type of the object to instantiate.

defaultValue - The value to return if the specified property name does not exist in the configuration.

Returns:

Returns the entire configuration as an instance of T.

Throws:

IllegalArgumentException - if the value cannot be converted to an instance of T.

See Also:

• Configuration.getProperty(String)

getRequiredAs

public <T> T getRequiredAs(Type type)
                    throws NoSuchElementException,
IllegalArgumentException

Description copied from interface: Configuration

Generic object accessor.

Specified by:

getRequiredAs in interface Configuration

Type Parameters:

T - The type to return.

Parameters:

type - The type of the object to instantiate.

Returns:

Returns the entire configuration as an instance of T.

Throws:

NoSuchElementException - throws the RuntimeException if the configuration is not available.

IllegalArgumentException - if the value cannot be converted to an instance of T.

toLogValue

public Object toLogValue()

Generate a Steno log compatible representation.

Returns:

Steno log compatible representation.

toString

public String toString()

Overrides:

toString in class Object