org.eclipse.jetty.util

Enum IteratingCallback.Action

java.lang.Object

java.lang.Enum<IteratingCallback.Action>

org.eclipse.jetty.util.IteratingCallback.Action

All Implemented Interfaces:

Serializable, Comparable<IteratingCallback.Action>

Enclosing class:

IteratingCallback

protected static enum IteratingCallback.Action
extends Enum<IteratingCallback.Action>

The indication of the overall progress of the overall job that implementations of IteratingCallback.process() must return.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED Indicates that IteratingCallback.process() has failed the overall job.
IDLE Indicates that IteratingCallback.process() has no more work to do, but the overall job is not completed yet, probably waiting for additional events to trigger more work.
SCHEDULED Indicates that IteratingCallback.process() is executing asynchronously a sub task, where the execution has started but the callback may have not yet been invoked.
SUCCEEDED Indicates that IteratingCallback.process() has completed the overall job.

Method Summary

Methods

Modifier and Type	Method and Description
static IteratingCallback.Action	valueOf(String name) Returns the enum constant of this type with the specified name.
static IteratingCallback.Action[]	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

IDLE

public static final IteratingCallback.Action IDLE

Indicates that IteratingCallback.process() has no more work to do, but the overall job is not completed yet, probably waiting for additional events to trigger more work.

SCHEDULED

public static final IteratingCallback.Action SCHEDULED

Indicates that IteratingCallback.process() is executing asynchronously a sub task, where the execution has started but the callback may have not yet been invoked.

SUCCEEDED

public static final IteratingCallback.Action SUCCEEDED

Indicates that IteratingCallback.process() has completed the overall job.

FAILED

public static final IteratingCallback.Action FAILED

Indicates that IteratingCallback.process() has failed the overall job.

Method Detail

values

public static IteratingCallback.Action[] 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 (IteratingCallback.Action c : IteratingCallback.Action.values())
    System.out.println(c);

Returns:

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

valueOf

public static IteratingCallback.Action 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