public class ProgressIndicatorParameter extends ChoiceParameter<String>
| Constructor and Description |
|---|
ProgressIndicatorParameter(String name)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
ProgressIndicator |
progressIndicatorValue(Environment env)
Returns the progress indicator indicated by the value of this parameter.
|
String |
stringToObject(Environment env,
String sval)
Takes a non-blank string, as supplied by the execution environment,
and turns it into a typed value for this parameter.
|
getUsage, objectToString, setDefaultOption, setUsageaddOption, addOption, choiceToString, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, stringifyOption, stringToChoiceclearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toStringpublic ProgressIndicatorParameter(String name)
name - parameter namepublic ProgressIndicator progressIndicatorValue(Environment env) throws TaskException
env - execution environmentTaskExceptionpublic String stringToObject(Environment env, String sval) throws TaskException
ParameterIt is an error to supply a null or empty string value.
If this method fails (throws a ParameterValueException)
and if allowClassnameValue is set, then a subsequent
attempt will be made to interpret the stringVal
as the classname of a suitable class with a no-arg constructor.
stringToObject in class ChoiceParameter<String>env - execution environment; in most cases this is not required
but for some purposes environment-specific characteristics
may influence the resultsval - non-null, non-empty string valueTaskExceptionCopyright © 2024 Central Laboratory of the Research Councils. All Rights Reserved.