rcf.core.framework.component
Class DynamicPropertyEvent.Caused<T,P extends DynamicProperty<T>>

java.lang.Object
  rcf.core.framework.component.DynamicPropertyEvent.Caused<T,P>

Type Parameters:

T -

P -

All Implemented Interfaces:

CausedEvent, Event, EventCausedEvent, ThrowableCausedEvent, DynamicPropertyEvent<T,P>

Enclosing interface:

DynamicPropertyEvent<T,P extends DynamicProperty<T>>

public static final class DynamicPropertyEvent.Caused<T,P extends DynamicProperty<T>>
extends Object
implements DynamicPropertyEvent<T,P>, CausedEvent

TODO: Javadoc

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

Version:

$Revision: 1.2 $

Author:

Greg Gibeling

Nested Class Summary

Nested classes/interfaces inherited from interface rcf.core.framework.component.DynamicPropertyEvent

DynamicPropertyEvent.Caused<T,P extends DynamicProperty<T>>, DynamicPropertyEvent.Default<T,P extends DynamicProperty<T>>

Field Summary

protected T	after TODO: Javadoc
protected T	before TODO: Javadoc
protected Event	eventCause TODO: Javadoc
protected int	eventSequenceNumber
protected P	source TODO: Javadoc
protected Throwable	throwableCause TODO: Javadoc

Constructor Summary

DynamicPropertyEvent.Caused(P _source, T _before, T _after, Throwable _throwableCause, Event _eventCause)
TODO: Javadoc

Method Summary

T	after() TODO: Javadoc
T	before() TODO: Javadoc
Event	eventCause() Get the event which caused this event.
int	getEventSequenceNumber() Get the sequence number of this event relative to it's Event.source().
boolean	isCancelled() Test if this event has been cancelled.
P	source() Get the EventSource this event was generated from.
Throwable	throwableCause() Get the throwable which caused this event.

Methods inherited from class java.lang.Object

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

Field Detail

after

protected final T after

TODO: Javadoc

before

protected final T before

TODO: Javadoc

eventSequenceNumber

protected final int eventSequenceNumber

source

protected final P extends DynamicProperty<T> source

TODO: Javadoc

throwableCause

protected final Throwable throwableCause

TODO: Javadoc

eventCause

protected final Event eventCause

TODO: Javadoc

Constructor Detail

DynamicPropertyEvent.Caused

public DynamicPropertyEvent.Caused(P _source,
                                   T _before,
                                   T _after,
                                   Throwable _throwableCause,
                                   Event _eventCause)

TODO: Javadoc

Parameters:

_source -

_before -

_after -

_throwableCause -

_eventCause -

Method Detail

after

public T after()

Description copied from interface: DynamicPropertyEvent

TODO: Javadoc

Specified by:

after in interface DynamicPropertyEvent<T,P extends DynamicProperty<T>>

Returns:

before

public T before()

Description copied from interface: DynamicPropertyEvent

TODO: Javadoc

Specified by:

before in interface DynamicPropertyEvent<T,P extends DynamicProperty<T>>

Returns:

eventCause

public Event eventCause()

Description copied from interface: EventCausedEvent

Get the event which caused this event.

Specified by:

eventCause in interface EventCausedEvent

Returns:

The event which caused this event.

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 P 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 DynamicPropertyEvent<T,P extends DynamicProperty<T>>

Returns:

The EventSource this event was generated from.

throwableCause

public Throwable throwableCause()

Description copied from interface: ThrowableCausedEvent

Get the throwable which caused this event.

Specified by:

throwableCause in interface ThrowableCausedEvent

Returns:

The throwable which caused this event.