de.skuzzle.jeve

Class SequentialEvent<T,L extends Listener>

java.lang.Object

de.skuzzle.jeve.Event<T,L>

de.skuzzle.jeve.SequentialEvent<T,L>

Type Parameters:

T - Type of the source of this event.

L - Type of the listener which can handle this event.

public class SequentialEvent<T,L extends Listener>
extends Event<T,L>

Specialized Event for use with SynchronousEventProviders. It supports prevention of nested Events when being dispatched.

Since:

3.0.0

Author:

Simon Taddiken

Constructor Summary

Constructors

Constructor and Description
SequentialEvent(T source, Class<L> listenerClass) Creates a new event with a given source.

Method Summary

Modifier and Type	Method and Description
void	addSuppressedEvent(SuppressedEvent e) Adds a SuppressedEvent to the set of suppressed events of this Event.
Optional<Event<?,?>>	getCause() Gets the cause of this event.
Optional<EventStack>	getEventStack() Gets the current event stack.
Set<Class<?>>	getPrevented() Gets the listener classes to which dispatching should be prevented while this event is being dispatched.
Set<SuppressedEvent>	getSuppressedEvents() Gets a read-only set of the suppressed events that have been registered at this event using addSuppressedEvent(SuppressedEvent).
void	preventCascade() Prevents to dispatch events with the same listener class as this one as long as this event is being dispatched.
<E extends Listener> void	preventCascade(Class<E> listenerClass) Prevents to dispatch events to the given listener class while this event is being dispatched.
void	setEventStack(EventStack eventStack) Sets the EventStack which is used while this event is dispatched.

Methods inherited from class de.skuzzle.jeve.Event

getListenerClass, getListenerStore, getProperties, getSource, getValue, getValueAs, isHandled, isPrevented, setHandled, setListenerStore, setPrevented, setValue, stopNotifying

Methods inherited from class java.lang.Object

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

Constructor Detail

SequentialEvent

public SequentialEvent(T source,
                       Class<L> listenerClass)

Creates a new event with a given source.

Parameters:

source - The source of this event.

listenerClass - The type of the listener which can handle this event. This value must not be null.

Method Detail

setEventStack

public void setEventStack(EventStack eventStack)

Sets the EventStack which is used while this event is dispatched. This method will be called by the SequentialEventProvider right before dispatching this event. The stack is only set once, subsequent calls will have no effect.

Parameters:

eventStack - The current event stack.

getCause

public Optional<Event<?,?>> getCause()

Gets the cause of this event. An event has a cause attached if it was dispatched while another event has been dispatched.

Returns:

The cause of this event if it exists.

getEventStack

public Optional<EventStack> getEventStack()

Gets the current event stack. A stack will only be present if the event is being dispatched by an event provider which calls setEventStack(EventStack) before dispatching (like SequentialEventProvider).

Returns:

The current event stack if present.

addSuppressedEvent

public void addSuppressedEvent(SuppressedEvent e)

Adds a SuppressedEvent to the set of suppressed events of this Event. If a capable EventProvider determines that a certain event has been prevented because its listener class has been registered on this event using preventCascade(Class), then the prevented event is registered here using this method.

Parameters:

e - The event to add.

Throws:

IllegalArgumentException - If the event is null.

getSuppressedEvents

public Set<SuppressedEvent> getSuppressedEvents()

Gets a read-only set of the suppressed events that have been registered at this event using addSuppressedEvent(SuppressedEvent).

Returns:

The suppressed events.

preventCascade

public <E extends Listener> void preventCascade(Class<E> listenerClass)

Prevents to dispatch events to the given listener class while this event is being dispatched. This is only supported when dispatching this event with an EventProvider which supports the EventStack.

Note: this method has to be called before this event is being dispatched. If called during dispatch, it will have no effect.

Type Parameters:

E - Type of the listener class.

Parameters:

listenerClass - The listener class to prevent being notified.

See Also:

preventCascade()

preventCascade

public void preventCascade()

Prevents to dispatch events with the same listener class as this one as long as this event is being dispatched. This is only supported when dispatching this event with an EventProvider which supports the EventStack.

See Also:

preventCascade(Class)

getPrevented

public Set<Class<?>> getPrevented()

Gets the listener classes to which dispatching should be prevented while this event is being dispatched.

Returns:

The listener classes marked to prevent.

See Also:

preventCascade(Class)