uk.ac.starlink.ttools.task

Class JoinFixActionParameter.Fixer

java.lang.Object

uk.ac.starlink.ttools.task.JoinFixActionParameter.Fixer

Enclosing class:

JoinFixActionParameter

public abstract static class JoinFixActionParameter.Fixer
extends Object

Helper class which defines how suffixes are turned into JoinFixActions.

Constructor Summary

Constructors

Constructor and Description
Fixer(String name, String description) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract JoinFixAction	createAction(Environment env, StringParameter suffixParam) Returns a JoinFixAction corresponding to a given label.
String	getDescription() Returns a short description of the function of this object.
String	toString() Returns object name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Fixer

public Fixer(String name,
             String description)

Constructor.

Parameters:

name - object name, for presentation to the user as a parameter value

description - short description of the function

Method Detail

createAction

public abstract JoinFixAction createAction(Environment env,
                                           StringParameter suffixParam)
                                    throws TaskException

Returns a JoinFixAction corresponding to a given label.

Parameters:

env - execution environment

suffixParam - parameter supplying suffix value (got from a createSuffixParameter method)

Throws:

TaskException

getDescription

public String getDescription()

Returns a short description of the function of this object.

Returns:

description

toString

public String toString()

Returns object name.

Overrides:

toString in class Object