|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter
uk.ac.starlink.ttools.task.OutputModeParameter
public class OutputModeParameter
Parameter for table output mode.
Constructor Summary | |
---|---|
OutputModeParameter(String name)
Constructor. |
Method Summary | |
---|---|
TableConsumer |
consumerValue(uk.ac.starlink.task.Environment env)
Returns a TableConsumer which corresponds to the value of this parameter. |
String |
getExtraUsage(TableEnvironment env)
Returns an extended usage message. |
String |
getModeUsage(String modeName,
String prefix)
Returns a usage message for a given processing mode. |
void |
setValueFromConsumer(TableConsumer consumer)
Sets the value directly from a given TableConsumer. |
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, 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 |
---|
public OutputModeParameter(String name)
name
- parameter nameMethod Detail |
---|
public String getExtraUsage(TableEnvironment env)
ExtraParameter
getExtraUsage
in interface ExtraParameter
env
- execution envrionment
public String getModeUsage(String modeName, String prefix) throws uk.ac.starlink.util.LoadException
modeName
- name of the modeprefix
- prefix for each line of output (e.g. padding spaces)
uk.ac.starlink.util.LoadException
public void setValueFromString(uk.ac.starlink.task.Environment env, String stringval) throws uk.ac.starlink.task.TaskException
setValueFromString
in class uk.ac.starlink.task.Parameter
uk.ac.starlink.task.TaskException
public TableConsumer consumerValue(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException
consumerValue
in interface TableConsumerParameter
env
- execution environment
uk.ac.starlink.task.TaskException
public void setValueFromConsumer(TableConsumer consumer)
setValueFromConsumer
in interface TableConsumerParameter
consumer
- table consumer
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |