org.apache.commons.pipeline
Enum StageDriver.State

java.lang.Object
  java.lang.Enum<StageDriver.State>
      org.apache.commons.pipeline.StageDriver.State

All Implemented Interfaces:

Serializable, Comparable<StageDriver.State>

Enclosing interface:

StageDriver

public static enum StageDriver.State
extends Enum<StageDriver.State>

This enumeration represents possible states of the a stage driver during processing.

Enum Constant Summary

ERROR
A fatal error has occurred that has caused the driver to stop in an inconsistent state.

FINISHED
Postprocessing tasks are complete; the stage is shutting down.

RUNNING
Preprocessing is complete and objects are being processed.

STARTED
The stage driver has started and the preprocess() method is being run.

STOP_REQUESTED
A stop has been requested - the stage will finish processing, then postprocess and shut down.

STOPPED
Resources have been released and all stage activity has stopped, or the stage has never been started.

Method Summary

static StageDriver.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static StageDriver.State[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STOPPED

public static final StageDriver.State STOPPED

Resources have been released and all stage activity has stopped, or the stage has never been started. This is the default state.

STARTED

public static final StageDriver.State STARTED

The stage driver has started and the preprocess() method is being run.

RUNNING

public static final StageDriver.State RUNNING

Preprocessing is complete and objects are being processed.

STOP_REQUESTED

public static final StageDriver.State STOP_REQUESTED

A stop has been requested - the stage will finish processing, then postprocess and shut down.

FINISHED

public static final StageDriver.State FINISHED

Postprocessing tasks are complete; the stage is shutting down.

ERROR

public static final StageDriver.State ERROR

A fatal error has occurred that has caused the driver to stop in an inconsistent state. The driver cannot be restarted from the error state. The error(s) can be obtained using the getFatalErrors method.

Method Detail

values

public static StageDriver.State[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StageDriver.State c : StageDriver.State.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StageDriver.State valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null