Class StringConfigKey


  • public class StringConfigKey
    extends ConfigKey<java.lang.String>
    Config key for use with String values.
    Since:
    23 Feb 2013
    Author:
    Mark Taylor
    • Constructor Summary

      Constructors 
      Constructor Description
      StringConfigKey​(ConfigMeta meta, java.lang.String dflt)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Specifier<java.lang.String> createSpecifier()
      Constructs a graphical control with which the user can specify a suitable value for association with this key.
      java.lang.String stringToValue​(java.lang.String txt)
      Decodes a string value to the value type of this key.
      java.lang.String valueToString​(java.lang.String 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

      • StringConfigKey

        public StringConfigKey​(ConfigMeta meta,
                               java.lang.String dflt)
        Constructor.
        Parameters:
        meta - metadata
        dflt - default value
    • Method Detail

      • stringToValue

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

        public java.lang.String valueToString​(java.lang.String 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.String>
        Parameters:
        value - possible value associated with this key
        Returns:
        string representation
      • createSpecifier

        public Specifier<java.lang.String> 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.String>
        Returns:
        new specifier