de.gerdiproject.harvest.config.parameters

Class AbstractParameter<V>

java.lang.Object

de.gerdiproject.harvest.config.parameters.AbstractParameter<V>

Type Parameters:

V - The underlying type of the parameter value

Direct Known Subclasses:

BooleanParameter, IntegerParameter, StringParameter

public abstract class AbstractParameter<V>
extends Object

Parameters are part of the Configuration. Each parameter holds some information about how and when it can be changed.

Author:

Robin Weiss

Field Summary

Fields

Modifier and Type	Field and Description
protected String	category
protected String	key
protected static org.slf4j.Logger	LOGGER
protected Function<String,V>	mappingFunction
protected V	value

Constructor Summary

Constructors

Constructor and Description
AbstractParameter(String key, String category, V defaultValue, Function<String,V> customMappingFunction) Constructor that uses a custom mapping function.

Method Summary

Modifier and Type	Method and Description
abstract AbstractParameter<V>	copy() Creates an unregistered copy of this parameter.
String	getCategory() Retrieves the name of the category to which the parameter belongs.
String	getCompositeKey() Returns a unique key consisting of the category and the parameter key.
String	getKey() Retrieves the key of the parameter.
Function<String,V>	getMappingFunction() Retrieves a function that maps a String value to V.
String	getStringValue() Returns a human readable String of the parameter value.
V	getValue() Retrieves the parameter value.
boolean	isRegistered() Returns true if the parameter is registered at the Configuration.
void	loadFromEnvironmentVariables() Looks for an environment variable that contains the category and key of this parameter and sets the value to that of the environment variable.
void	setMappingFunction(Function<String,V> mappingFunction) Sets the function that maps a String value to V.
void	setRegistered(boolean registered) Determines if the parameter is registered at the Configuration.
void	setValue(String value) Changes the stored value by parsing a String argument.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

value

protected V value

key

protected final String key

category

protected final String category

mappingFunction

protected Function<String,V> mappingFunction

Constructor Detail

AbstractParameter

public AbstractParameter(String key,
                         String category,
                         V defaultValue,
                         Function<String,V> customMappingFunction)
                  throws IllegalArgumentException

Constructor that uses a custom mapping function.

Parameters:

key - the unique key of the parameter, which is used to change it via REST

category - the category of the parameter

defaultValue - the default value

customMappingFunction - a function that maps strings to the parameter values

Throws:

IllegalArgumentException - thrown if the key contains invalid characters

Method Detail

copy

public abstract AbstractParameter<V> copy()

Creates an unregistered copy of this parameter.

Returns:

a copy of this parameter

getCompositeKey

public String getCompositeKey()

Returns a unique key consisting of the category and the parameter key.

Returns:

a unique key consisting of the category and the parameter key

getStringValue

public String getStringValue()

Returns a human readable String of the parameter value.

Returns:

a human readable String of the parameter value

setValue

public final void setValue(String value)
                    throws IllegalArgumentException

Changes the stored value by parsing a String argument.

Parameters:

value - a String representation of the new value

Throws:

IllegalArgumentException - if the value could not be changed

loadFromEnvironmentVariables

public void loadFromEnvironmentVariables()

Looks for an environment variable that contains the category and key of this parameter and sets the value to that of the environment variable.

toString

public String toString()

Overrides:

toString in class Object

getValue

public V getValue()

Retrieves the parameter value.

Returns:

the parameter value

getKey

public String getKey()

Retrieves the key of the parameter. The key must be unique within the category.

Returns:

the key of the parameter

getCategory

public String getCategory()

Retrieves the name of the category to which the parameter belongs.

Returns:

the name of the category to which the parameter belongs

getMappingFunction

public Function<String,V> getMappingFunction()

Retrieves a function that maps a String value to V.

Returns:

a function that maps a String value to V

setMappingFunction

public void setMappingFunction(Function<String,V> mappingFunction)

Sets the function that maps a String value to V.

Parameters:

mappingFunction - a function that maps a String value to V

isRegistered

public boolean isRegistered()

Returns true if the parameter is registered at the Configuration.

Returns:

true if the parameter is registered at the Configuration

setRegistered

public void setRegistered(boolean registered)

Determines if the parameter is registered at the Configuration.

Parameters:

registered - true if the parameter is registered at the Configuration