|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<String>
uk.ac.starlink.task.StringParameter
uk.ac.starlink.ttools.task.InputFormatParameter
public class InputFormatParameter
Parameter for selecting input table format.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
InputFormatParameter(String name)
|
Method Summary | |
---|---|
String |
getExtraUsage(TableEnvironment env)
Returns an extended usage message. |
String |
getUsage()
Returns the usage string for this parameter. |
void |
setTableDescription(String inDescrip,
AbstractInputTableParameter tableParam)
Sets the wording used to refer to the input table in parameter descriptions. |
String |
stringToObject(Environment env,
String stringval)
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.Parameter |
---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public InputFormatParameter(String name)
Method Detail |
---|
public final void setTableDescription(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 String getUsage()
Parameter
getUsage
in class Parameter<String>
Parameter.setUsage(java.lang.String)
public String getExtraUsage(TableEnvironment env)
ExtraParameter
getExtraUsage
in interface ExtraParameter
env
- execution envrionment
public String stringToObject(Environment env, String stringval) throws TaskException
Parameter
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.
stringToObject
in class StringParameter
env
- execution environment; in most cases this is not required
but for some purposes environment-specific characteristics
may influence the resultstringval
- non-null, non-empty string value
TaskException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |