org.freehep.record.loop

Class LoopEvent

java.lang.Object

java.util.EventObject

org.freehep.record.loop.LoopEvent

All Implemented Interfaces:

Serializable

public class LoopEvent
extends EventObject

An event sent by RecordLoop to LoopListeners. An event represents an immutable snapshot of the loop at the moment when the event was created.

Version:

$Id$

Author:

Dmitry Onoprienko

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LoopEvent(RecordLoop loop, RecordLoop.Event type, RecordLoop.State state, RecordLoop.Command command, Object[] commandParameters, Throwable exception, boolean pauseRequested, boolean stopRequested, long supplied, long totalSupplied, long consumed, long totalConsumed, long countableConsumed, long totalCountableConsumed, long timeInLoop)

Method Summary

Methods

Modifier and Type	Method and Description
RecordLoop.Command	getCommand() Returns the command that was being executed or had just finished executing.
Object[]	getCommandParameters() Returns a reference to the array containing parameters of the command that was being executed or had just finished executing.
long	getConsumed() Returns the number of records consumed by listeners in the latest LOOPING phase, or zero the loop moved through IDLE state since then.
long	getCountableConsumed() Returns the number of countable records consumed by listeners in the latest LOOPING phase, or zero the loop moved through IDLE state since then.
RecordLoop.Event	getEventType() Returns the type of this event.
Throwable	getException() Returns the exception thrown while executing the last command.
RecordLoop	getSource() Returns the record loop that fired this event.
RecordLoop.State	getState() Returns the state of the loop when this event was fired.
long	getSupplied() Returns the number of records supplied to listeners in the latest LOOPING phase, or zero the loop moved through IDLE state since then.
long	getTimeInLoop() Returns the duration of the latest LOOPING phase, in milliseconds.
long	getTotalConsumed() Returns the number of records consumed by listeners since the last START event.
long	getTotalCountableConsumed() Returns the number of countable records consumed by listeners since the last START event.
long	getTotalSupplied() Returns the number of records supplied to listeners since the last START event.
boolean	isPauseRequested() Returns true if PAUSE command was issued to this loop while is was in the LOOPING state last time before this event was fired.
boolean	isStopRequested() Returns true if STOP command was issued to this loop while is was in the LOOPING state last time before this event was fired.

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LoopEvent

public LoopEvent(RecordLoop loop,
         RecordLoop.Event type,
         RecordLoop.State state,
         RecordLoop.Command command,
         Object[] commandParameters,
         Throwable exception,
         boolean pauseRequested,
         boolean stopRequested,
         long supplied,
         long totalSupplied,
         long consumed,
         long totalConsumed,
         long countableConsumed,
         long totalCountableConsumed,
         long timeInLoop)

Method Detail

getSource

public RecordLoop getSource()

Returns the record loop that fired this event.

Overrides:

getSource in class EventObject

getEventType

public RecordLoop.Event getEventType()

Returns the type of this event.

getState

public RecordLoop.State getState()

Returns the state of the loop when this event was fired.

getCommand

public RecordLoop.Command getCommand()

Returns the command that was being executed or had just finished executing.

getCommandParameters

public Object[] getCommandParameters()

Returns a reference to the array containing parameters of the command that was being executed or had just finished executing.

Callers should not modify the array or its contents to avoid altering the behavior of the loop, possibly in an unpredictable way.

isPauseRequested

public boolean isPauseRequested()

Returns true if PAUSE command was issued to this loop while is was in the LOOPING state last time before this event was fired.

isStopRequested

public boolean isStopRequested()

Returns true if STOP command was issued to this loop while is was in the LOOPING state last time before this event was fired.

getException

public Throwable getException()

Returns the exception thrown while executing the last command. Returns null if no exceptions have been thrown.

getSupplied

public long getSupplied()

Returns the number of records supplied to listeners in the latest LOOPING phase, or zero the loop moved through IDLE state since then.

getTotalSupplied

public long getTotalSupplied()

Returns the number of records supplied to listeners since the last START event.

getConsumed

public long getConsumed()

Returns the number of records consumed by listeners in the latest LOOPING phase, or zero the loop moved through IDLE state since then.

getTotalConsumed

public long getTotalConsumed()

Returns the number of records consumed by listeners since the last START event.

getCountableConsumed

public long getCountableConsumed()

Returns the number of countable records consumed by listeners in the latest LOOPING phase, or zero the loop moved through IDLE state since then.

getTotalCountableConsumed

public long getTotalCountableConsumed()

Returns the number of countable records consumed by listeners since the last START event.

getTimeInLoop

public long getTimeInLoop()

Returns the duration of the latest LOOPING phase, in milliseconds.