org.freehep.record.loop

Enum RecordLoop.Event

java.lang.Object

java.lang.Enum<RecordLoop.Event>

org.freehep.record.loop.RecordLoop.Event

All Implemented Interfaces:

Serializable, Comparable<RecordLoop.Event>

Enclosing interface:

RecordLoop

public static enum RecordLoop.Event
extends Enum<RecordLoop.Event>

Enumeration of LoopEvent types that can be fired by this loop.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONFIGURE Fired once the CONFIG or the SET_SOURCE command has been processed by this loop.
FINISH Fired at the end of record processing, once this loop has moved from READY to IDLE state.
PROGRESS Fired at certain intervals while this loop is processing records.
RESET Fired once this loop has executed the REWIND command.
RESUME Fired when record processing is resumed, once this loop has moved from READY to LOOPING state.
START Fired at the start of record processing, once this loop has moved from IDLE to READY state.
SUSPEND Fired when record processing is paused, once this loop has moved from LOOPING to READY state.

Method Summary

Methods

Modifier and Type	Method and Description
static RecordLoop.Event	valueOf(String name) Returns the enum constant of this type with the specified name.
static RecordLoop.Event[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

START

public static final RecordLoop.Event START

Fired at the start of record processing, once this loop has moved from IDLE to READY state.

FINISH

public static final RecordLoop.Event FINISH

Fired at the end of record processing, once this loop has moved from READY to IDLE state.

RESUME

public static final RecordLoop.Event RESUME

Fired when record processing is resumed, once this loop has moved from READY to LOOPING state.

SUSPEND

public static final RecordLoop.Event SUSPEND

Fired when record processing is paused, once this loop has moved from LOOPING to READY state.

CONFIGURE

public static final RecordLoop.Event CONFIGURE

Fired once the CONFIG or the SET_SOURCE command has been processed by this loop.

PROGRESS

public static final RecordLoop.Event PROGRESS

Fired at certain intervals while this loop is processing records.

RESET

public static final RecordLoop.Event RESET

Fired once this loop has executed the REWIND command.

Method Detail

values

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

Returns:

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

valueOf

public static RecordLoop.Event 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