|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<T>
uk.ac.starlink.task.ObjectFactoryParameter<ProcessingMode>
uk.ac.starlink.ttools.task.OutputModeParameter
public class OutputModeParameter
Parameter for table output mode.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
OutputModeParameter(String name)
Constructor. |
Method Summary | |
---|---|
TableConsumer |
consumerValue(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,
int indent)
Returns a usage message for a given processing mode. |
void |
setValueFromConsumer(Environment env,
TableConsumer consumer)
Sets the value directly from a given TableConsumer. |
Methods inherited from class uk.ac.starlink.task.ObjectFactoryParameter |
---|
getObjectFactory, getUsage, stringToObject |
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 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, int indent) throws LoadException
modeName
- name of the modeindent
- number of spaces to indent each line
LoadException
public TableConsumer consumerValue(Environment env) throws TaskException
TableConsumerParameter
consumerValue
in interface TableConsumerParameter
env
- execution environment
TaskException
public void setValueFromConsumer(Environment env, TableConsumer consumer) throws TaskException
setValueFromConsumer
in interface TableConsumerParameter
env
- execution environmentconsumer
- table consumer
TaskException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |