org.transitime.config

Class StringConfigValue

java.lang.Object

org.transitime.config.ConfigValue<java.lang.String>

org.transitime.config.StringConfigValue

public class StringConfigValue
extends ConfigValue<java.lang.String>

For specifying a String parameter that can be read in from xml config file.

Author:

SkiBu Smith

Nested Class Summary

Nested classes/interfaces inherited from class org.transitime.config.ConfigValue

ConfigValue.ConfigParamException

Constructor Summary

Constructors

Constructor and Description
StringConfigValue(java.lang.String id, java.lang.String description) Constructor.
StringConfigValue(java.lang.String id, java.lang.String defaultValue, java.lang.String description) Constructor for when there is a default value.
StringConfigValue(java.lang.String id, java.lang.String defaultValue, java.lang.String description, boolean okToLogValue) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString() So that can use the StringConfigValue directly as a String without explicitly calling getValue().

Methods inherited from class org.transitime.config.ConfigValue

getDescription, getID, getValue

Methods inherited from class java.lang.Object

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

Constructor Detail

StringConfigValue

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

Constructor. For when there is no default value. Error will occur when parameter is initialized if it is not configured.

Parameters:

id -

description -

StringConfigValue

public StringConfigValue(java.lang.String id,
                         java.lang.String defaultValue,
                         java.lang.String description)

Constructor for when there is a default value.

Parameters:

id -

defaultValue - Default value, but can be set to null for if null is a reasonable default.

description -

StringConfigValue

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

Constructor.

Parameters:

id -

defaultValue -

description -

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

Method Detail

toString

public java.lang.String toString()

So that can use the StringConfigValue directly as a String without explicitly calling getValue().

Overrides:

toString in class ConfigValue<java.lang.String>