public class InputFormatParameter extends uk.ac.starlink.task.StringParameter implements ExtraParameter
Constructor and Description |
---|
InputFormatParameter(java.lang.String name) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getExtraUsage(TableEnvironment env)
Returns an extended usage message.
|
java.lang.String |
getUsage() |
void |
setTableDescription(java.lang.String inDescrip,
AbstractInputTableParameter tableParam)
Sets the wording used to refer to the input table in parameter
descriptions.
|
java.lang.String |
stringToObject(uk.ac.starlink.task.Environment env,
java.lang.String stringval) |
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectToString, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString
public final void setTableDescription(java.lang.String inDescrip, AbstractInputTableParameter tableParam)
inDescrip
- text to replace "the input table"tableParam
- if supplied, gives the table parameter on behalf
of which this format parameter is operating;
may be nullpublic java.lang.String getUsage()
getUsage
in class uk.ac.starlink.task.Parameter<java.lang.String>
public java.lang.String getExtraUsage(TableEnvironment env)
ExtraParameter
getExtraUsage
in interface ExtraParameter
env
- execution envrionmentpublic java.lang.String stringToObject(uk.ac.starlink.task.Environment env, java.lang.String stringval) throws uk.ac.starlink.task.TaskException
stringToObject
in class uk.ac.starlink.task.StringParameter
uk.ac.starlink.task.TaskException
Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.