net.sf.jaccumulator

Enum ControlIntention

java.lang.Object

java.lang.Enum<ControlIntention>

net.sf.jaccumulator.ControlIntention

All Implemented Interfaces:

Serializable, Comparable<ControlIntention>

public enum ControlIntention
extends Enum<ControlIntention>

Communicate a general control intention outside of the current state processor

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (nicole@tedesco.name)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTINUE The current control flow has not yet completed, but the most recent event has not been ignored and in fact has probably been buffered.
DONE The current control flow has completed successfully and the state model has reached the end of a terminal control flow.
EXCEPTION An unexpected state has been reached that lies is outside of the state model's design specification.
FAIL A current control flow has completed with a controlled rejection of input; an input was not appropriate, but was within design parameters for the state model.
REJECT A current control flow has not advanced and the input was rejected.
SUCCESS The current control flow has completed successfully and the state model is ready for additional events.
UNKNOWN No control intention has been explicitly identified; don't care.
WAIT A current control flow has not yet completed, but the most recent event may have been ignored.

Method Summary

Methods

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

CONTINUE

public static final ControlIntention CONTINUE

The current control flow has not yet completed, but the most recent event has not been ignored and in fact has probably been buffered. Future calls are encouraged.

DONE

public static final ControlIntention DONE

The current control flow has completed successfully and the state model has reached the end of a terminal control flow. Final results are available and the state model requires a reset before additional processing can continue.

EXCEPTION

public static final ControlIntention EXCEPTION

An unexpected state has been reached that lies is outside of the state model's design specification. Future calls are discouraged.

FAIL

public static final ControlIntention FAIL

A current control flow has completed with a controlled rejection of input; an input was not appropriate, but was within design parameters for the state model. Future calls should be avoided until the state model has been reset.

REJECT

public static final ControlIntention REJECT

A current control flow has not advanced and the input was rejected. Future calls however, are encouraged.

SUCCESS

public static final ControlIntention SUCCESS

The current control flow has completed successfully and the state model is ready for additional events. Future calls are encouraged.

UNKNOWN

public static final ControlIntention UNKNOWN

No control intention has been explicitly identified; don't care. Future calls are neither encouraged or discouraged.

WAIT

public static final ControlIntention WAIT

A current control flow has not yet completed, but the most recent event may have been ignored. Future calls are encouraged to drain internal event queues.

Method Detail

values

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

Returns:

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

valueOf

public static ControlIntention 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