org.transitime.config

Class ConfigValue<T>

java.lang.Object

org.transitime.config.ConfigValue<T>

Direct Known Subclasses:

BooleanConfigValue, DoubleConfigValue, FloatConfigValue, IntegerConfigValue, LongConfigValue, StringConfigValue, StringListConfigValue

public abstract class ConfigValue<T>
extends java.lang.Object

Abstract class for storing a single param. These params are read from the command line as Java properties or from an XML file at startup. Goal is to make the accessing of the data fast, since it might be accessed in loops. Yet also want to be able to reread the data when needed. Also works when need a list of data.

Author:

SkiBu Smith

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigValue.ConfigParamException An exception for when a parameter is being read in

Constructor Summary

Constructors

Constructor and Description
ConfigValue(java.lang.String id, java.lang.String description) Stores info associated with ConfigValue.
ConfigValue(java.lang.String id, T defaultValue, java.lang.String description) Stores info associated with ConfigValue.
ConfigValue(java.lang.String id, T defaultValue, java.lang.String description, boolean okToLogValue) Stores info associated with ConfigValue.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns the description of the parameter.
java.lang.String	getID() Returns the ID of the parameter.
T	getValue() Gets the value.
java.lang.String	toString() So that the value is returned instead of the default toString() which returns the object ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigValue

public ConfigValue(java.lang.String id,
                   java.lang.String description)

Stores info associated with ConfigValue. Outputs error message if id param null or already used.

Parameters:

id -

description -

ConfigValue

public ConfigValue(java.lang.String id,
                   T defaultValue,
                   java.lang.String description)

Stores info associated with ConfigValue. Outputs error message if id param null or already used.

Parameters:

id -

defaultValue -

description -

ConfigValue

public ConfigValue(java.lang.String id,
                   T defaultValue,
                   java.lang.String description,
                   boolean okToLogValue)

Stores info associated with ConfigValue. Outputs error message if id param null or already used.

Parameters:

id -

defaultValue -

description -

okToLogValue - If false then won't log value in log file. This is useful for passwords and such.

Method Detail

getValue

public T getValue()

Gets the value. Intended to be fast because might be used in loops. Therefore there is no locking.

Returns:

the current value of the param.

getID

public java.lang.String getID()

Returns the ID of the parameter. This can be useful for outputting as part of error messages so that user can see what parameter needs to be modified when there is a problem.

Returns:

getDescription

public java.lang.String getDescription()

Returns the description of the parameter.

Returns:

toString

public java.lang.String toString()

So that the value is returned instead of the default toString() which returns the object ID. This makes debugging easier.

Overrides:

toString in class java.lang.Object