org.threadly.load

Class ParameterStore

java.lang.Object

org.threadly.load.ParameterStore

Direct Known Subclasses:

ScriptFactory, ScriptRunner

public class ParameterStore
extends java.lang.Object

Storage for parameters, providing a common interface for retriving them. Properties will be provided after construction and can be accessed via getIntValue(String), getIntValue(String, int), getLongValue(String), getLongValue(String, long), getDoubleValue(String), getDoubleValue(String, double), getStringValue(String) and getStringValue(String, String).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterStore.ParameterException Exception type that indicates an error with one of the parameters.

Constructor Summary

Constructors

Constructor and Description
ParameterStore() Construct a ParameterStore with the parameters to be provided later from initialize(Properties).
ParameterStore(java.util.Properties properties) Constructs a new ParameterStore with the parameters used for backing, or null if it is desired to set the parameters later using initialize(Properties).

Method Summary

Modifier and Type	Method and Description
boolean	getBoolValue(java.lang.String key) Returns a boolean value parameter for the given key.
boolean	getBoolValue(java.lang.String key, boolean defaultVal) Returns a boolean value parameter for the given key.
double	getDoubleValue(java.lang.String key) Returns a double value parameter for the given key.
double	getDoubleValue(java.lang.String key, double defaultVal) Returns a double value parameter for the given key.
int	getIntValue(java.lang.String key) Returns an int value parameter for the given key.
int	getIntValue(java.lang.String key, int defaultVal) Returns an int value parameter for the given key.
long	getLongValue(java.lang.String key) Returns a long value parameter for the given key.
long	getLongValue(java.lang.String key, long defaultVal) Returns a long value parameter for the given key.
java.util.Map<java.lang.String,java.lang.String>	getPossibleParameters() This is an optional function to override.
java.lang.String	getStringValue(java.lang.String key) Returns a string value parameter for the given key.
java.lang.String	getStringValue(java.lang.String key, java.lang.String defaultVal) Returns a String value parameter for the given key.
static java.util.Properties	parseProperties(java.lang.String[] args, int offset, int length) Parse the parameters from an array of String arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterStore

public ParameterStore()

Construct a ParameterStore with the parameters to be provided later from initialize(Properties).

ParameterStore

public ParameterStore(java.util.Properties properties)

Constructs a new ParameterStore with the parameters used for backing, or null if it is desired to set the parameters later using initialize(Properties).

Parameters:

properties - Properties to load parameters from

Method Detail

parseProperties

public static java.util.Properties parseProperties(java.lang.String[] args,
                                                   int offset,
                                                   int length)

Parse the parameters from an array of String arguments. It is expected that each String be in the format of key=value. Any '=' signs in the keys or values are unexpected and may cause issues.

Parameters:

args - Array of arguments to parse through

offset - Offset into array to start parsing from

length - Number of elements which should be inspected

Returns:

New properties reference which has the parsed out key/values

getPossibleParameters

public java.util.Map<java.lang.String,java.lang.String> getPossibleParameters()

This is an optional function to override. It is highly recommended it is overridden if using ScriptRunner. This provides documentation for what parameters are used by this builder. If someone fails to provide a parameter this will be displayed to the CLI so that it makes it easier to know what was missing. This is triggered by throwing ParameterStore.ParameterException. This map is structured such that the key represents the parameter key. The value is an optional description to describe what the key represents.

Returns:

Map with keys that indicate the parameters used, and values representing their description

getBoolValue

public boolean getBoolValue(java.lang.String key)

Returns a boolean value parameter for the given key. If no value for the given key is found, a ParameterStore.ParameterException will be thrown. If the parameter may or may not exist use getBoolValue(String, boolean). If unable to parse the boolean for the key a ParameterStore.ParameterException. It is expected that the string value to represent the boolean will be either "true" or "false".

Parameters:

key - Key to lookup the boolean value from

Returns:

Boolean parameter value or the provided default if none is found

getIntValue

public int getIntValue(java.lang.String key)

Returns an int value parameter for the given key. If no value for the given key is found, a ParameterStore.ParameterException will be thrown. If the parameter may or may not exist use getIntValue(String, int). If unable to parse the integer for the key a ParameterStore.ParameterException will be thrown with a NumberFormatException being the cause.

Parameters:

key - Key to lookup the integer value from

Returns:

Integer parameter value

getLongValue

public long getLongValue(java.lang.String key)

Returns a long value parameter for the given key. If no value for the given key is found, a ParameterStore.ParameterException will be thrown. If the parameter may or may not exist use getLongValue(String, long). If unable to parse the long for the key a ParameterStore.ParameterException will be thrown with a NumberFormatException being the cause.

Parameters:

key - Key to lookup the long value from

Returns:

Long parameter value

getDoubleValue

public double getDoubleValue(java.lang.String key)

Returns a double value parameter for the given key. If no value for the given key is found, a ParameterStore.ParameterException will be thrown. If the parameter may or may not exist use getDoubleValue(String, double). If unable to parse the double for the key a ParameterStore.ParameterException will be thrown with a NumberFormatException being the cause.

Parameters:

key - Key to lookup the long value from

Returns:

Long parameter value

getStringValue

public java.lang.String getStringValue(java.lang.String key)

Returns a string value parameter for the given key. If no value for the given key is found, a ParameterStore.ParameterException will be thrown. If the parameter may or may not exist use getStringValue(String, String).

Parameters:

key - Key to lookup the String value from

Returns:

String parameter value

getBoolValue

public boolean getBoolValue(java.lang.String key,
                            boolean defaultVal)

Returns a boolean value parameter for the given key. If no value for the given key is found then the provided default will be returned. If unable to parse the boolean for the key a ParameterStore.ParameterException. It is expected that the string value to represent the boolean will be either "true" or "false".

Parameters:

key - Key to lookup the boolean value from

defaultVal - Value to be returned if there is no value for the key

Returns:

Boolean parameter value or the provided default if none is found

getIntValue

public int getIntValue(java.lang.String key,
                       int defaultVal)

Returns an int value parameter for the given key. If no value for the given key is found then the provided default will be returned. If unable to parse the integer for the key a ParameterStore.ParameterException will be thrown with a NumberFormatException being the cause.

Parameters:

key - Key to lookup the integer value from

defaultVal - Value to be returned if there is no value for the key

Returns:

Integer parameter value or the provided default if none is found

getLongValue

public long getLongValue(java.lang.String key,
                         long defaultVal)

Returns a long value parameter for the given key. If no value for the given key is found then the provided default will be returned. If unable to parse the long for the key a ParameterStore.ParameterException will be thrown with a NumberFormatException being the cause.

Parameters:

key - Key to lookup the long value from

defaultVal - Value to be returned if there is no value for the key

Returns:

Long parameter value or the provided default if none is found

getDoubleValue

public double getDoubleValue(java.lang.String key,
                             double defaultVal)

Returns a double value parameter for the given key. If no value for the given key is found then the provided default will be returned. If unable to parse the double for the key a ParameterStore.ParameterException will be thrown with a NumberFormatException being the cause.

Parameters:

key - Key to lookup the double value from

defaultVal - Value to be returned if there is no value for the key

Returns:

Double parameter value or the provided default if none is found

getStringValue

public java.lang.String getStringValue(java.lang.String key,
                                       java.lang.String defaultVal)

Returns a String value parameter for the given key. If no value for the given key is found then the provided default will be returned.

Parameters:

key - Key to lookup the string value from

defaultVal - Value to be returned if there is no value for the key

Returns:

String parameter value or the provided default if none is found