Constructor Detail

• SkySysConfigKey

  public SkySysConfigKey(ConfigMeta meta,
                         boolean includeNull)

  Constructor.

  Parameters:

  meta - config key metadata

  includeNull - true iff null is a permitted option

Method Detail

• valueToString

  public java.lang.String valueToString(SkySys sys)

  Description copied from class: OptionConfigKey
  Invokes the toString method of the supplied option. May be overridden.

  Overrides:

  valueToString in class OptionConfigKey<SkySys>

  Parameters:

  sys - possible value associated with this key

  Returns:

  string representation

• stringToValue

  public SkySys stringToValue(java.lang.String str)
                       throws ConfigException

  Description copied from class: OptionConfigKey
  Calls valueToString repeatedly looking for a match. This means that if valueToString is overridden it is usually not necessary to override this method.

  Overrides:

  stringToValue in class OptionConfigKey<SkySys>

  Parameters:

  str - string representation of value

  Returns:

  value

  Throws:

  ConfigException

• getXmlDescription

  public java.lang.String getXmlDescription(SkySys sys)

  Description copied from class: OptionConfigKey
  Returns a description in XML of the given option value. This, along with OptionConfigKey.valueToString(T), is used by the OptionConfigKey.getOptionsXml() method to assemble a described list of the options.

  Specified by:

  getXmlDescription in class OptionConfigKey<SkySys>

  Parameters:

  sys - possible value of this key

  Returns:

  short snippet of XML (not wrapped in any outer element) describing the value; may be null if no description required or available