de.skuzzle.jeve

Interface SuppressedEvent

public interface SuppressedEvent

Holds information about an event which has not been dispatched because it was prevented by an other event. If an EventProvider encounters that an Event should not be fired because of other events currently being dispatched, it attaches an instance of this class to the event which prevented this one.

Implementations must implement equals and hashCode based on the object returned by getEvent(). This ensures that no duplicated SuppressedEvents for the same Event are added to an event.

Since:

3.0.0

Author:

Simon Taddiken

See Also:

SequentialEventProvider

Method Summary

Modifier and Type	Method and Description
Event<?,?>	getEvent() The Event object which has not been dispatched.
Class<? extends Listener>	getListenerClass() The listener class of the suppressed event.
void	redispatch(EventProvider<?> provider) Tries to dispatch this event again using the given provider.

Method Detail

getEvent

Event<?,?> getEvent()

The Event object which has not been dispatched.

Returns:

The event.

getListenerClass

Class<? extends Listener> getListenerClass()

The listener class of the suppressed event.

Returns:

The listener class of the event returned by getEvent().

redispatch

void redispatch(EventProvider<?> provider)

Tries to dispatch this event again using the given provider. If this event is still prevented, it won't be dispatched. As the event takes the normal way through the dispatch mechanism, it will then be added again as a suppressed event to event which is preventing it.

Parameters:

provider - The EventProvider to dispatch the event with.