|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<T>
uk.ac.starlink.task.ChoiceParameter<T>
uk.ac.starlink.ttools.plottask.StyleParameter<T>
public class StyleParameter<T>
ChoiceParameter subclass suitable for use with plotting style configuration. Adds a few useful customisations.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
StyleParameter(String name,
Class<T> clazz)
Constructs a StyleParameter without initialising any options. |
|
StyleParameter(String name,
T[] options)
Constructs a StyleParameter with a given list of options. |
Method Summary | |
---|---|
String |
getOptionList()
Returns a formatted XML string giving an unordered list of the options for this parameter. |
String |
getUsage()
Returns a usage message. |
void |
setUsage(String usage)
Sets a usage string for this parameter. |
String |
stringifyOption(T option)
Determines how an option will be represented as a string value of this parameter if no name has explicitly been supplied. |
Methods inherited from class uk.ac.starlink.task.ChoiceParameter |
---|
addOption, addOption, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, objectToString, setDefaultOption, stringToObject |
Methods inherited from class uk.ac.starlink.task.Parameter |
---|
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public StyleParameter(String name, T[] options)
name
- parameter nameoptions
- list of optionspublic StyleParameter(String name, Class<T> clazz)
name
- parameter nameMethod Detail |
---|
public void setUsage(String usage)
Parameter
Parameter
class uses the string "<value>"
as the default usage string.
setUsage
in class ChoiceParameter<T>
usage
- usage stringpublic String getUsage()
ChoiceParameter
ChoiceParameter.setUsage(java.lang.String)
, this will return a usage message based on
the list of known options.
getUsage
in class ChoiceParameter<T>
Parameter.setUsage(java.lang.String)
public String getOptionList()
public String stringifyOption(T option)
ChoiceParameter
String.valueOf(option)
,
but this may be overrridden.
stringifyOption
in class ChoiceParameter<T>
option
- option value
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |