Package uk.ac.starlink.ttools.join
Class ProgressIndicatorParameter
java.lang.Object
uk.ac.starlink.task.Parameter<T>
uk.ac.starlink.task.AbstractChoiceParameter<T,T>
uk.ac.starlink.task.ChoiceParameter<String>
uk.ac.starlink.ttools.join.ProgressIndicatorParameter
Parameter for getting a ProgressIndicator.
- Since:
- 20 Nov 2007
- Author:
- Mark Taylor
-
Field Summary
Fields inherited from class uk.ac.starlink.task.Parameter
BY_NAME
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionuk.ac.starlink.table.join.ProgressIndicator
progressIndicatorValue
(uk.ac.starlink.task.Environment env) Returns the progress indicator indicated by the value of this parameter.stringToObject
(uk.ac.starlink.task.Environment env, String sval) Methods inherited from class uk.ac.starlink.task.ChoiceParameter
getUsage, objectToString, setDefaultOption, setUsage
Methods inherited from class uk.ac.starlink.task.AbstractChoiceParameter
addOption, addOption, choiceToString, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, stringifyOption, stringToChoice
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
-
Constructor Details
-
ProgressIndicatorParameter
Constructor.- Parameters:
name
- parameter name
-
-
Method Details
-
progressIndicatorValue
public uk.ac.starlink.table.join.ProgressIndicator progressIndicatorValue(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException Returns the progress indicator indicated by the value of this parameter.- Parameters:
env
- execution environment- Returns:
- progress indicator, not null
- Throws:
uk.ac.starlink.task.TaskException
-
stringToObject
public String stringToObject(uk.ac.starlink.task.Environment env, String sval) throws uk.ac.starlink.task.TaskException - Overrides:
stringToObject
in classuk.ac.starlink.task.ChoiceParameter<String>
- Throws:
uk.ac.starlink.task.TaskException
-