ExtraParameter
, TableConsumerParameter
public class OutputModeParameter extends uk.ac.starlink.task.ObjectFactoryParameter<ProcessingMode> implements TableConsumerParameter, ExtraParameter
Constructor | Description |
---|---|
OutputModeParameter(java.lang.String name) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
TableConsumer |
consumerValue(uk.ac.starlink.task.Environment env) |
Returns a TableConsumer which corresponds to the value of this
parameter.
|
java.lang.String |
getExtraUsage(TableEnvironment env) |
Returns an extended usage message.
|
java.lang.String |
getModeUsage(java.lang.String modeName,
int indent) |
Returns a usage message for a given processing mode.
|
void |
setValueFromConsumer(uk.ac.starlink.task.Environment env,
TableConsumer consumer) |
Sets the value directly from a given TableConsumer.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getObjectFactory, getUsage, stringToObject
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 OutputModeParameter(java.lang.String name)
name
- parameter namepublic java.lang.String getExtraUsage(TableEnvironment env)
ExtraParameter
getExtraUsage
in interface ExtraParameter
env
- execution envrionmentpublic java.lang.String getModeUsage(java.lang.String modeName, int indent) throws uk.ac.starlink.util.LoadException
modeName
- name of the modeindent
- number of spaces to indent each lineuk.ac.starlink.util.LoadException
public TableConsumer consumerValue(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException
TableConsumerParameter
consumerValue
in interface TableConsumerParameter
env
- execution environmentuk.ac.starlink.task.TaskException
public void setValueFromConsumer(uk.ac.starlink.task.Environment env, TableConsumer consumer) throws uk.ac.starlink.task.TaskException
setValueFromConsumer
in interface TableConsumerParameter
env
- execution environmentconsumer
- table consumeruk.ac.starlink.task.TaskException
Copyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.