uk.ac.starlink.ttools.join
Class ProgressIndicatorParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter
      extended by uk.ac.starlink.task.BooleanParameter
          extended by uk.ac.starlink.ttools.join.ProgressIndicatorParameter

public class ProgressIndicatorParameter
extends uk.ac.starlink.task.BooleanParameter

Parameter for getting a ProgressIndicator.

Since:
20 Nov 2007
Author:
Mark Taylor

Constructor Summary
ProgressIndicatorParameter(String name)
          Constructor.
 
Method Summary
 uk.ac.starlink.table.join.ProgressIndicator progressIndicatorValue(uk.ac.starlink.task.Environment env)
          Returns the value of this parameter as a ProgressIndicator object.
 void setValueFromString(uk.ac.starlink.task.Environment env, String sval)
           
 
Methods inherited from class uk.ac.starlink.task.BooleanParameter
booleanValue, setDefault
 
Methods inherited from class uk.ac.starlink.task.Parameter
checkGotValue, clearValue, getDefault, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getUsage, isNullPermitted, setDefault, setDescription, setDescription, setGotValue, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringValue, setUsage, stringValue, 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

setValueFromString

public void setValueFromString(uk.ac.starlink.task.Environment env,
                               String sval)
                        throws uk.ac.starlink.task.TaskException
Overrides:
setValueFromString in class uk.ac.starlink.task.BooleanParameter
Throws:
uk.ac.starlink.task.TaskException

progressIndicatorValue

public uk.ac.starlink.table.join.ProgressIndicator progressIndicatorValue(uk.ac.starlink.task.Environment env)
                                                                   throws uk.ac.starlink.task.TaskException
Returns the value of this parameter as a ProgressIndicator object.

Parameters:
env - execution environment
Returns:
progress indicator
Throws:
uk.ac.starlink.task.TaskException


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