uk.ac.starlink.ttools.join
Class ProgressIndicatorParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter<T>
      extended by uk.ac.starlink.task.ChoiceParameter<String>
          extended by uk.ac.starlink.ttools.join.ProgressIndicatorParameter

public class ProgressIndicatorParameter
extends ChoiceParameter<String>

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
ProgressIndicatorParameter(String name)
          Constructor.
 
Method Summary
 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.
 
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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProgressIndicatorParameter

public ProgressIndicatorParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

progressIndicatorValue

public ProgressIndicator progressIndicatorValue(Environment env)
                                         throws TaskException
Returns the progress indicator indicated by the value of this parameter.

Parameters:
env - execution environment
Returns:
progress indicator, not null
Throws:
TaskException

stringToObject

public String stringToObject(Environment env,
                             String sval)
                      throws TaskException
Description copied from class: Parameter
Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter. This method also performs validation, so if the string value is unacceptable in any way, a ParameterValueException should be thrown.

It 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.

Overrides:
stringToObject in class ChoiceParameter<String>
Parameters:
env - execution environment; in most cases this is not required but for some purposes environment-specific characteristics may influence the result
sval - non-null, non-empty string value
Returns:
typed value
Throws:
TaskException


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.