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