de.gerdiproject.harvest.config.parameters

Class BooleanParameter

java.lang.Object

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

de.gerdiproject.harvest.config.parameters.BooleanParameter

public class BooleanParameter
extends AbstractParameter<Boolean>

This parameter represents a boolean flag.

Author:

Robin Weiss

Field Summary

Fields inherited from class de.gerdiproject.harvest.config.parameters.AbstractParameter

category, key, LOGGER, mappingFunction, value

Constructor Summary

Constructors

Constructor and Description
BooleanParameter(String key, String category, boolean defaultValue) Constructor that uses the default mapping function.
BooleanParameter(String key, String category, boolean defaultValue, Function<String,Boolean> customMappingFunction) Constructor that uses a custom mapping function.

Method Summary

Modifier and Type	Method and Description
BooleanParameter	copy() Creates an unregistered copy of this parameter.

Methods inherited from class de.gerdiproject.harvest.config.parameters.AbstractParameter

getCategory, getCompositeKey, getKey, getMappingFunction, getStringValue, getValue, isRegistered, loadFromEnvironmentVariables, setMappingFunction, setRegistered, setValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanParameter

public BooleanParameter(String key,
                        String category,
                        boolean defaultValue,
                        Function<String,Boolean> 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

BooleanParameter

public BooleanParameter(String key,
                        String category,
                        boolean defaultValue)

Constructor that uses the default 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

Method Detail

copy

public BooleanParameter copy()

Description copied from class: AbstractParameter

Creates an unregistered copy of this parameter.

Specified by:

copy in class AbstractParameter<Boolean>

Returns:

a copy of this parameter