Class BooleanConfigKey
java.lang.Object
uk.ac.starlink.ttools.plot2.config.ConfigKey<Boolean>
uk.ac.starlink.ttools.plot2.config.BooleanConfigKey
Config key for boolean values.
- Since:
- 22 Feb 2013
- Author:
- Mark Taylor
-
Constructor Summary
ConstructorsConstructorDescriptionBooleanConfigKey
(ConfigMeta meta) Constructs a key with a false default.BooleanConfigKey
(ConfigMeta meta, boolean dflt) Constructs a key with explicit default. -
Method Summary
Modifier and TypeMethodDescriptionConstructs a graphical control with which the user can specify a suitable value for association with this key.static boolean
Indicates whether the given string represents the value False.static boolean
Indicates whether the given string represents the value True.stringToValue
(String txt) Decodes a string value to the value type of this key.valueToString
(Boolean value) Reports a value as a string.Methods inherited from class uk.ac.starlink.ttools.plot2.config.ConfigKey
cast, getDefaultValue, getMeta, getValueClass, toString
-
Constructor Details
-
BooleanConfigKey
Constructs a key with explicit default.- Parameters:
meta
- metadatadflt
- default value
-
BooleanConfigKey
Constructs a key with a false default.- Parameters:
meta
- metadata
-
-
Method Details
-
stringToValue
Description copied from class:ConfigKey
Decodes a string value to the value type of this key. An empty string should be interpreted as a null value, but this may cause an exception if null is not a permissible value for this key.- Specified by:
stringToValue
in classConfigKey<Boolean>
- Parameters:
txt
- string representation of value- Returns:
- value
- Throws:
ConfigException
-
valueToString
Description copied from class:ConfigKey
Reports a value as a string. If at all possible the roundtripping should be possible, sostringToValue(valueToString(v)).equals(v)
. A null value, if permitted, should be represented as an empty string.- Specified by:
valueToString
in classConfigKey<Boolean>
- Parameters:
value
- possible value associated with this key- Returns:
- string representation
-
createSpecifier
Description copied from class:ConfigKey
Constructs a graphical control with which the user can specify a suitable value for association with this key.- Specified by:
createSpecifier
in classConfigKey<Boolean>
- Returns:
- new specifier
-
isTrue
Indicates whether the given string represents the value True.- Parameters:
txt
- string- Returns:
- true iff txt means True
-
isFalse
Indicates whether the given string represents the value False.- Parameters:
txt
- string- Returns:
- true iff txt means False
-