uk.ac.starlink.ttools.task
Class OutputTableParameter
java.lang.Object
uk.ac.starlink.task.Parameter<TableConsumer>
uk.ac.starlink.ttools.task.OutputTableParameter
- All Implemented Interfaces:
- TableConsumerParameter
public class OutputTableParameter
- extends Parameter<TableConsumer>
- implements TableConsumerParameter
Parameter to hold an output table.
Methods inherited from class uk.ac.starlink.task.Parameter |
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getUsage, getValueClass, isNullPermitted, objectToString, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toString |
OutputTableParameter
public OutputTableParameter(String name)
getFormatParameter
public OutputFormatParameter getFormatParameter()
stringToObject
public TableConsumer stringToObject(Environment env,
String sval)
throws TaskException
- Description copied from class:
Parameter
- Takes a non-blank string, as supplied by the execution environment,
and turns it into a typed value for this parameter.
This method also performs validation, so if the string value
is unacceptable in any way, a ParameterValueException should
be thrown.
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.
- Specified by:
stringToObject
in class Parameter<TableConsumer>
- Parameters:
env
- execution environment; in most cases this is not required
but for some purposes environment-specific characteristics
may influence the resultsval
- non-null, non-empty string value
- Returns:
- typed value
- Throws:
TaskException
consumerValue
public TableConsumer consumerValue(Environment env)
throws TaskException
- Description copied from interface:
TableConsumerParameter
- Returns a TableConsumer which corresponds to the value of this
parameter.
- Specified by:
consumerValue
in interface TableConsumerParameter
- Parameters:
env
- execution environment
- Throws:
TaskException
setValueFromConsumer
public void setValueFromConsumer(Environment env,
TableConsumer consumer)
throws TaskException
- Description copied from interface:
TableConsumerParameter
- Sets the value of this parameter directly from a TableConsumer.
- Specified by:
setValueFromConsumer
in interface TableConsumerParameter
- Parameters:
env
- execution environmentconsumer
- consumer
- Throws:
TaskException
Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.