Class BooleanConfigKey


  • public class BooleanConfigKey
    extends ConfigKey<java.lang.Boolean>
    Config key for boolean values.
    Since:
    22 Feb 2013
    Author:
    Mark Taylor
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Specifier<java.lang.Boolean> createSpecifier()
      Constructs a graphical control with which the user can specify a suitable value for association with this key.
      static boolean isFalse​(java.lang.String txt)
      Indicates whether the given string represents the value False.
      static boolean isTrue​(java.lang.String txt)
      Indicates whether the given string represents the value True.
      java.lang.Boolean stringToValue​(java.lang.String txt)
      Decodes a string value to the value type of this key.
      java.lang.String valueToString​(java.lang.Boolean value)
      Reports a value as a string.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • BooleanConfigKey

        public BooleanConfigKey​(ConfigMeta meta,
                                boolean dflt)
        Constructs a key with explicit default.
        Parameters:
        meta - metadata
        dflt - default value
      • BooleanConfigKey

        public BooleanConfigKey​(ConfigMeta meta)
        Constructs a key with a false default.
        Parameters:
        meta - metadata
    • Method Detail

      • stringToValue

        public java.lang.Boolean stringToValue​(java.lang.String txt)
                                        throws ConfigException
        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 class ConfigKey<java.lang.Boolean>
        Parameters:
        txt - string representation of value
        Returns:
        value
        Throws:
        ConfigException
      • valueToString

        public java.lang.String valueToString​(java.lang.Boolean value)
        Description copied from class: ConfigKey
        Reports a value as a string. If at all possible the roundtripping should be possible, so stringToValue(valueToString(v)).equals(v). A null value, if permitted, should be represented as an empty string.
        Specified by:
        valueToString in class ConfigKey<java.lang.Boolean>
        Parameters:
        value - possible value associated with this key
        Returns:
        string representation
      • createSpecifier

        public Specifier<java.lang.Boolean> 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 class ConfigKey<java.lang.Boolean>
        Returns:
        new specifier
      • isTrue

        public static boolean isTrue​(java.lang.String txt)
        Indicates whether the given string represents the value True.
        Parameters:
        txt - string
        Returns:
        true iff txt means True
      • isFalse

        public static boolean isFalse​(java.lang.String txt)
        Indicates whether the given string represents the value False.
        Parameters:
        txt - string
        Returns:
        true iff txt means False