CopyMode (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.mode.CopyMode

All Implemented Interfaces:

ProcessingMode
```
public class CopyMode
extends java.lang.Object
implements ProcessingMode
```
Processing mode which writes out a table.

Since:

11 Feb 2005

Author:

Mark Taylor (Starlink)

Constructor Summary

Constructors
Constructor Description

CopyMode()

Constructors
Constructor	Description
`CopyMode()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TableConsumer`	`createConsumer(uk.ac.starlink.task.Environment env)`	Creates a TableConsumer, deriving any additional required configuration from a given environment.
`static TableConsumer`	`createConsumer(uk.ac.starlink.task.Environment env, java.lang.String loc, java.lang.String fmt)`	Creates a TableConsumer which writes to a given location.
`uk.ac.starlink.task.Parameter[]`	`getAssociatedParameters()`	Returns a list of any parameters which are associated with this mode.
`java.lang.String`	`getDescription()`	Returns a textual description of this processing mode.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CopyMode
```
public CopyMode()
```
- Method Detail
  - getAssociatedParameters
```
public uk.ac.starlink.task.Parameter[] getAssociatedParameters()
```
    Description copied from interface: ProcessingMode
    
    Returns a list of any parameters which are associated with this mode.
    
    Specified by:
    
    getAssociatedParameters in interface ProcessingMode
    
    Returns:
    
    parameter list
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: ProcessingMode
    
    Returns a textual description of this processing mode. This will be included in the user document so should be in XML.
    
    Specified by:
    
    getDescription in interface ProcessingMode
    
    Returns:
    
    textual description of this mode
  - createConsumer
```
public TableConsumer createConsumer(uk.ac.starlink.task.Environment env)
                             throws uk.ac.starlink.task.TaskException
```
    Description copied from interface: ProcessingMode
    
    Creates a TableConsumer, deriving any additional required configuration from a given environment.
    
    Specified by:
    
    createConsumer in interface ProcessingMode
    
    Parameters:
    
    env - execution environment
    
    Throws:
    
    uk.ac.starlink.task.TaskException
  - createConsumer
```
public static TableConsumer createConsumer(uk.ac.starlink.task.Environment env,
                                           java.lang.String loc,
                                           java.lang.String fmt)
                                    throws uk.ac.starlink.task.UsageException
```
    Creates a TableConsumer which writes to a given location.
    
    Parameters:
    
    env - execution environment
    
    loc - location of output
    
    fmt - output format name
    
    Throws:
    
    uk.ac.starlink.task.UsageException

Class CopyMode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CopyMode

Method Detail

getAssociatedParameters

getDescription

createConsumer

createConsumer