Package com.arpnetworking.configuration

Interface Configuration

All Known Implementing Classes:

BaseConfiguration, BaseJacksonConfiguration, DynamicConfiguration, StaticConfiguration

public interface Configuration

Interface for classes which provide configuration.

Author:

Ville Koskela (ville dot koskela at inscopemetrics dot io)

Method Summary

Modifier and Type	Method	Description
<T> Optional<T>	getAs(Class<? extends T> clazz)	Generic object accessor.
<T> T	getAs(Class<? extends T> clazz, T defaultValue)	Generic object accessor.
<T> Optional<T>	getAs(Type type)	Generic object accessor.
<T> T	getAs(Type type, T defaultValue)	Generic object accessor.
Optional<String>	getProperty(String name)	Retrieve the value of a particular property by its name.
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> Optional<T>	getPropertyAs(String name, Class<? extends T> clazz)	Generic object accessor.
<T> T	getPropertyAs(String name, Class<? extends T> clazz, T defaultValue)	Generic object accessor.
<T> Optional<T>	getPropertyAs(String name, Type type)	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.

Method Details

getProperty

Optional<String> getProperty(String name)

Retrieve the value of a particular property by its name.

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.

getProperty

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.

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

String getRequiredProperty(String name)
                    throws NoSuchElementException

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

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

Optional<Boolean> getPropertyAsBoolean(String name)

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

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:

• getProperty(String)

getPropertyAsBoolean

boolean getPropertyAsBoolean(String name,
 boolean defaultValue)

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

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:

• getProperty(String, String)

getRequiredPropertyAsBoolean

boolean getRequiredPropertyAsBoolean(String name)
                              throws NoSuchElementException

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

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:

• getRequiredProperty(String)

getPropertyAsInteger

Optional<Integer> getPropertyAsInteger(String name)
                                throws NumberFormatException

Integer specific accessor.

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:

• getProperty(String)

getPropertyAsInteger

int getPropertyAsInteger(String name,
 int defaultValue)
                  throws NumberFormatException

Integer specific accessor.

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:

• getProperty(String, String)

getRequiredPropertyAsInteger

int getRequiredPropertyAsInteger(String name)
                          throws NoSuchElementException,
NumberFormatException

Integer specific accessor.

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:

• getRequiredProperty(String)

getPropertyAsLong

Optional<Long> getPropertyAsLong(String name)
                          throws NumberFormatException

Long specific accessor.

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:

• getProperty(String)

getPropertyAsLong

long getPropertyAsLong(String name,
 long defaultValue)
                throws NumberFormatException

Long specific accessor.

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:

• getProperty(String, String)

getRequiredPropertyAsLong

long getRequiredPropertyAsLong(String name)
                        throws NoSuchElementException,
NumberFormatException

Long specific accessor.

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:

• getRequiredProperty(String)

getPropertyAsDouble

Optional<Double> getPropertyAsDouble(String name)
                              throws NumberFormatException

Double specific accessor.

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:

• getProperty(String)

getPropertyAsDouble

double getPropertyAsDouble(String name,
 double defaultValue)
                    throws NumberFormatException

Double specific accessor.

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:

• getProperty(String, String)

getRequiredPropertyAsDouble

double getRequiredPropertyAsDouble(String name)
                            throws NoSuchElementException,
NumberFormatException

Double specific accessor.

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:

• getRequiredProperty(String)

getPropertyAsFloat

Optional<Float> getPropertyAsFloat(String name)
                            throws NumberFormatException

Float specific accessor.

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:

• getProperty(String)

getPropertyAsFloat

float getPropertyAsFloat(String name,
 float defaultValue)
                  throws NumberFormatException

Float specific accessor.

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:

• getProperty(String, String)

getRequiredPropertyAsFloat

float getRequiredPropertyAsFloat(String name)
                          throws NoSuchElementException,
NumberFormatException

Float specific accessor.

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:

• getRequiredProperty(String)

getPropertyAsShort

Optional<Short> getPropertyAsShort(String name)
                            throws NumberFormatException

Short specific accessor.

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:

• getProperty(String)

getPropertyAsShort

short getPropertyAsShort(String name,
 short defaultValue)
                  throws NumberFormatException

Short specific accessor.

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:

• getProperty(String, String)

getRequiredPropertyAsShort

short getRequiredPropertyAsShort(String name)
                          throws NoSuchElementException,
NumberFormatException

Short specific accessor.

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:

• getRequiredProperty(String)

getPropertyAs

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

Generic object accessor.

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:

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

getPropertyAs

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

Generic object accessor.

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

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

Generic object accessor.

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

<T> Optional<T> getAs(Class<? extends T> clazz)
               throws IllegalArgumentException

Generic object accessor.

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:

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

getAs

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

Generic object accessor.

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:

• getProperty(String)

getRequiredAs

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

Generic object accessor.

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

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

Generic object accessor.

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:

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

getPropertyAs

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

Generic object accessor.

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

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

Generic object accessor.

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

<T> Optional<T> getAs(Type type)
               throws IllegalArgumentException

Generic object accessor.

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:

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

getAs

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

Generic object accessor.

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:

• getProperty(String)

getRequiredAs

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

Generic object accessor.

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.