Package dev.prozilla.pine.common.event

Interface EventDispatcherProvider<EventType extends Enum<EventType>,Target,E extends Event<EventType,Target>>

All Superinterfaces:

EventDispatcherContext<EventType,Target,E>

All Known Implementing Classes:

Node

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@ProviderOf(EventDispatcher.class)
@FunctionalInterface
public interface EventDispatcherProvider<EventType extends Enum<EventType>,Target,E extends Event<EventType,Target>>
extends EventDispatcherContext<EventType,Target,E>

Nested Class Summary

Nested classes/interfaces inherited from interface dev.prozilla.pine.common.event.EventDispatcherContext

EventDispatcherContext.EphemeralEventListener<EventType extends Enum<EventType>,E extends Event<EventType,?>>

Method Summary

Modifier and Type	Method	Description
default EventListener<E>	addListener(EventType eventType, EventListener<E> listener)	Adds a listener that listens to a given type of event.
EventDispatcher<EventType,Target,E>	getEventDispatcher()
default void	invoke(EventType eventType, Target target)	Invokes the event of a given type with a given target.
default void	removeListener(EventType eventType, EventListener<E> listener)	Removes a listener that was listening to a given type of event.

Methods inherited from interface dev.prozilla.pine.common.event.EventDispatcherContext

addListener, addTargetedListener, dispatchEvent, off, on, once

Method Details

getEventDispatcher

EventDispatcher<EventType,Target,E> getEventDispatcher()

addListener

default EventListener<E> addListener(EventType eventType,
 EventListener<E> listener)

Description copied from interface: EventDispatcherContext

Adds a listener that listens to a given type of event.

Unicity is not required. If a listener is added multiple times, it will be called multiple times per event.

Specified by:

addListener in interface EventDispatcherContext<EventType extends Enum<EventType>,Target,E extends Event<EventType,Target>>

Parameters:

eventType - The type of event to listen to

listener - The listener to add

Returns:

The listener that was added.

removeListener

default void removeListener(EventType eventType,
 EventListener<E> listener)

Description copied from interface: EventDispatcherContext

Removes a listener that was listening to a given type of event.

Specified by:

removeListener in interface EventDispatcherContext<EventType extends Enum<EventType>,Target,E extends Event<EventType,Target>>

Parameters:

eventType - The type of event that was being listened to

listener - The listener to remove

invoke

default void invoke(EventType eventType,
 Target target)

Description copied from interface: EventDispatcherContext

Invokes the event of a given type with a given target.

Specified by:

invoke in interface EventDispatcherContext<EventType extends Enum<EventType>,Target,E extends Event<EventType,Target>>

Parameters:

eventType - The type of event to invoke

target - The target of the event