NullMode (Starjava TTOOLS API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

All Implemented Interfaces:

ProcessingMode
```
public class NullMode
extends java.lang.Object
implements ProcessingMode
```
Processing mode which reads all data and disposes of it.

Since:

2 May 2006

Author:

Mark Taylor

Constructor Summary

Constructors
Constructor and Description

NullMode()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TableConsumer`	`createConsumer(uk.ac.starlink.task.Environment env)` Creates a TableConsumer, deriving any additional required configuration from a given environment.
`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
  - NullMode
```
public NullMode()
```
- 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)
```
    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

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.