uk.ac.starlink.ttools.task
Class InputFormatParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter
      extended by uk.ac.starlink.ttools.task.InputFormatParameter
All Implemented Interfaces:
ExtraParameter

public class InputFormatParameter
extends uk.ac.starlink.task.Parameter
implements ExtraParameter

Parameter for selecting input table format.

Since:
15 Aug 2005
Author:
Mark Taylor

Constructor Summary
InputFormatParameter(String name)
           
 
Method Summary
 String getExtraUsage(TableEnvironment env)
          Returns an extended usage message.
 String getUsage()
           
 void setValueFromString(uk.ac.starlink.task.Environment env, String stringval)
           
 
Methods inherited from class uk.ac.starlink.task.Parameter
checkGotValue, clearValue, getDefault, getDescription, getName, getPosition, getPreferExplicit, getPrompt, 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

InputFormatParameter

public InputFormatParameter(String name)
Method Detail

getUsage

public String getUsage()
Overrides:
getUsage in class uk.ac.starlink.task.Parameter

getExtraUsage

public String getExtraUsage(TableEnvironment env)
Description copied from interface: ExtraParameter
Returns an extended usage message. This should not repeat the content of the normal usage message. It should be preformatted, that is it should contain newlines to keep the line length down to less than 80 characters.

Specified by:
getExtraUsage in interface ExtraParameter
Parameters:
env - execution envrionment
Returns:
extended usage message

setValueFromString

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


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