OutputModeParameter (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.task.Parameter<T>
- - uk.ac.starlink.task.ObjectFactoryParameter<ProcessingMode>
  - - uk.ac.starlink.ttools.task.OutputModeParameter

All Implemented Interfaces:: ExtraParameter, TableConsumerParameter

public class OutputModeParameter
extends uk.ac.starlink.task.ObjectFactoryParameter<ProcessingMode>
implements TableConsumerParameter, ExtraParameter

Parameter for table output mode.

Since:: 15 Aug 2005
Author:: Mark Taylor

Field Summary
- Fields inherited from class uk.ac.starlink.task.Parameter
  BY_NAME

Constructor Summary

Constructors
Constructor and Description

OutputModeParameter(java.lang.String name)
Constructor.

Constructors
Constructor and Description
`OutputModeParameter(java.lang.String name)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.

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
  - OutputModeParameter
```
public OutputModeParameter(java.lang.String name)
```
    Constructor.
    
    Parameters:
    
    name - parameter name
- Method Detail
  - getExtraUsage
```
public java.lang.String getExtraUsage(TableEnvironment env)
```
    Description copied from interface: ExtraParameter
    
    Returns an extended usage message. This should not repeat the content of the normal usage message. It should be preformatted, that is it should contain newlines to keep the line length down to less than 80 characters.
    
    Specified by:
    
    getExtraUsage in interface ExtraParameter
    
    Parameters:
    
    env - execution envrionment
    
    Returns:
    
    extended usage message
  - getModeUsage
```
public java.lang.String getModeUsage(java.lang.String modeName,
                                     int indent)
                              throws uk.ac.starlink.util.LoadException
```
    Returns a usage message for a given processing mode.
    
    Parameters:
    
    modeName - name of the mode
    
    indent - number of spaces to indent each line
    
    Returns:
    
    usage message
    
    Throws:
    
    uk.ac.starlink.util.LoadException
  - consumerValue
```
public TableConsumer consumerValue(uk.ac.starlink.task.Environment env)
                            throws uk.ac.starlink.task.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:
    
    uk.ac.starlink.task.TaskException
  - setValueFromConsumer
```
public void setValueFromConsumer(uk.ac.starlink.task.Environment env,
                                 TableConsumer consumer)
                          throws uk.ac.starlink.task.TaskException
```
    Sets the value directly from a given TableConsumer.
    
    Specified by:
    
    setValueFromConsumer in interface TableConsumerParameter
    
    Parameters:
    
    env - execution environment
    
    consumer - table consumer
    
    Throws:
    
    uk.ac.starlink.task.TaskException

Class OutputModeParameter

Field Summary

Fields inherited from class uk.ac.starlink.task.Parameter

Constructor Summary

Method Summary

Methods inherited from class uk.ac.starlink.task.ObjectFactoryParameter

Methods inherited from class uk.ac.starlink.task.Parameter

Methods inherited from class java.lang.Object

Constructor Detail

OutputModeParameter

Method Detail

getExtraUsage

getModeUsage

consumerValue

setValueFromConsumer