|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.config.ConfigKey<T>
uk.ac.starlink.ttools.plot2.config.OptionConfigKey<SkySys>
uk.ac.starlink.ttools.plot2.config.SkySysConfigKey
public class SkySysConfigKey
ConfigKey for selecting sky coordinate systems.
Constructor Summary | |
---|---|
SkySysConfigKey(ConfigMeta meta,
boolean includeNull)
Constructor. |
Method Summary | |
---|---|
String |
getXmlDescription(SkySys sys)
Returns a description in XML of the given option value. |
SkySys |
stringToValue(String str)
Calls valueToString repeatedly looking for a match. |
String |
valueToString(SkySys sys)
Invokes the toString method of the supplied option. |
Methods inherited from class uk.ac.starlink.ttools.plot2.config.OptionConfigKey |
---|
addOptionsXml, createSpecifier, getOptions, getOptionsXml, setOptionUsage |
Methods inherited from class uk.ac.starlink.ttools.plot2.config.ConfigKey |
---|
cast, getDefaultValue, getMeta, getValueClass, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SkySysConfigKey(ConfigMeta meta, boolean includeNull)
meta
- config key metadataincludeNull
- true iff null is a permitted optionMethod Detail |
---|
public String valueToString(SkySys sys)
OptionConfigKey
toString
method of the supplied option.
May be overridden.
valueToString
in class OptionConfigKey<SkySys>
sys
- possible value associated with this key
public SkySys stringToValue(String str) throws ConfigException
OptionConfigKey
valueToString
repeatedly looking for a match.
This means that if valueToString
is overridden it
is usually not necessary to override this method.
stringToValue
in class OptionConfigKey<SkySys>
str
- string representation of value
ConfigException
public String getXmlDescription(SkySys sys)
OptionConfigKey
OptionConfigKey.valueToString(T)
,
is used by the OptionConfigKey.getOptionsXml()
method to assemble
a described list of the options.
getXmlDescription
in class OptionConfigKey<SkySys>
sys
- possible value of this key
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |