rcf.core.concurrent.schedule
Class TaskEvent.Default

java.lang.Object
  rcf.core.concurrent.schedule.TaskEvent.Default

All Implemented Interfaces:

Event, TaskEvent

Enclosing interface:

TaskEvent

public static class TaskEvent.Default
extends Object
implements TaskEvent

TODO: Javadoc

TODO: Unit tests, Code review, Javadoc review, Seal/Finalize TODO: equals, hashCode, toString

Version:

$Revision: 1.5 $

Author:

Greg Gibeling

Nested Class Summary

Nested classes/interfaces inherited from interface rcf.core.concurrent.schedule.TaskEvent

TaskEvent.Default

Field Summary

protected Task.State	after TODO: Javadoc
protected Task.State	before TODO: Javadoc
protected int	eventSequenceNumber
protected Task	source TODO: Javadoc

Constructor Summary

TaskEvent.Default(Task _source, Task.State _before, Task.State _after)
TODO: Javadoc

Method Summary

Task.State	after() TODO: Javadoc
Task.State	before() TODO: Javadoc
int	getEventSequenceNumber() Get the sequence number of this event relative to it's Event.source().
boolean	isCancelled() Test if this event has been cancelled.
Task	source() Get the EventSource this event was generated from.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

after

protected final Task.State after

TODO: Javadoc

before

protected final Task.State before

TODO: Javadoc

eventSequenceNumber

protected final int eventSequenceNumber

source

protected final Task source

TODO: Javadoc

Constructor Detail

TaskEvent.Default

public TaskEvent.Default(Task _source,
                         Task.State _before,
                         Task.State _after)

TODO: Javadoc

Parameters:

_source -

_before -

_after -

Method Detail

after

public Task.State after()

Description copied from interface: TaskEvent

TODO: Javadoc

Specified by:

after in interface TaskEvent

Returns:

before

public Task.State before()

Description copied from interface: TaskEvent

TODO: Javadoc

Specified by:

before in interface TaskEvent

Returns:

getEventSequenceNumber

public int getEventSequenceNumber()

Description copied from interface: Event

Get the sequence number of this event relative to it's Event.source().

Specified by:

getEventSequenceNumber in interface Event

Returns:

The sequence number of this event relative to it's Event.source().

isCancelled

public boolean isCancelled()

Description copied from interface: Event

Test if this event has been cancelled. This method is used to tell the event syndicate reporting this event to stop bothering, because it's been cancelled.

This is used in conjunction with Transaction.abort(). The return value from this method has no meaning outside of the event syndicate reporting loop. Often this method will simply return Task.taskState() == Task.State.Aborted.

Specified by:

isCancelled in interface Event

Returns:

true if this event has been cancelled, and no longer needs to be reported.

source

public Task source()

Description copied from interface: Event

Get the EventSource this event was generated from.

Specified by:

source in interface Event

Specified by:

source in interface TaskEvent

Returns:

The EventSource this event was generated from.