Package alexiil.mc.lib.multipart.api

Interface MultipartEventBus

public interface MultipartEventBus

The event bus for MultipartContainer's.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	MultipartEventBus.ContextlessListener<E extends MultipartEvent & ContextlessEvent>	An EventListener for a ContextlessEvent that is invoked with a Runnable.
static final class	MultipartEventBus.ExternalListener<E extends MultipartEvent>
static interface	MultipartEventBus.ListenerInfo<E extends MultipartEvent>	Information on a single registered listener.

Method Summary

Modifier and Type	Method	Description
default <E extends MultipartEvent & ContextlessEvent> MultipartEventBus.ListenerInfo<E>	addContextlessListener(Object key, Class<E> clazz, Runnable listener)	Adds a listener for a specified MultipartEvent that also implements ContextlessEvent with a Runnable.
default <E extends MultipartEvent> MultipartEventBus.ListenerInfo<E>	addExternalListener(Object key, Class<E> clazz, MultipartEventExternalListener<E> listener)	Adds a listener for a specified MultipartEvent (and all of it's subclasses), but also passes the MultipartContainer that the event was fired from ito the event handler.
<E extends MultipartEvent> MultipartEventBus.ListenerInfo<E>	addListener(Object key, Class<E> clazz, EventListener<E> listener)	Adds a listener for a specified MultipartEvent (and all of it's subclasses).
default <E extends MultipartEvent & ContextlessEvent> MultipartEventBus.ListenerInfo<E>	addRunOnceListener(Object key, Class<E> clazz, Runnable listener)	Adds a listener for a specified MultipartEvent that also implements ContextlessEvent with a Runnable.
boolean	fireEvent(MultipartEvent event)	Fires the given event to all currently registered listeners.
List<? extends MultipartEventBus.ListenerInfo<?>>	getAllListeners()
MultipartContainer	getContainer()
<E extends MultipartEvent> List<? extends MultipartEventBus.ListenerInfo<? extends E>>	getListeners(Class<E> clazz)
List<MultipartEventBus.ListenerInfo<? extends MultipartEvent>>	getListenersForKey(Object key)
default boolean	hasAnyListeners()
default boolean	hasAnyListenersFor(Class<? extends MultipartEvent> clazz)
default boolean	hasAnyListenersForKey(Object key)
void	removeListeners(Object key)	Removes all listeners that were added for the given key.

Method Details

getContainer

MultipartContainer getContainer()

Returns:

The MultipartContainer for this MultipartEventBus.

addListener

<E extends MultipartEvent>
MultipartEventBus.ListenerInfo<E> addListener(Object key,
 Class<E> clazz,
 EventListener<E> listener)

Adds a listener for a specified MultipartEvent (and all of it's subclasses).

This makes only one guarantee for event listener ordering: all listeners added for the same key will be called in the order that they are registered.

Parameters:

key - The identifier for the listener, compared with identity equality (==) and not object equality. Multiple listeners can be added with the same key. If the caller is an AbstractPart, and contained within this event bus's getContainer() then it is strongly recommended that the AbstractPart is re-used, because when that part is removed from the MultipartContainer removeListeners(Object) will be called with that part.

clazz - The type of event to listen to.

Throws:

NullPointerException - if any of the arguments are null.

addContextlessListener

default <E extends MultipartEvent & ContextlessEvent>
MultipartEventBus.ListenerInfo<E> addContextlessListener(Object key,
 Class<E> clazz,
 Runnable listener)

Adds a listener for a specified MultipartEvent that also implements ContextlessEvent with a Runnable.

This makes only one guarantee for event listener ordering: all listeners added for the same key will be called in the order that they are registered.

Parameters:

key - The identifier for the listener, compared with identity equality (==) and not object equality. Multiple listeners can be added with the same key. If the caller is an AbstractPart, and contained within this event bus's getContainer() then it is strongly recommended that the AbstractPart is re-used, because when that part is removed from the MultipartContainer removeListeners(Object) will be called with that part.

clazz - The type of event to listen to.

Throws:

NullPointerException - if any of the arguments are null.

addRunOnceListener

default <E extends MultipartEvent & ContextlessEvent>
MultipartEventBus.ListenerInfo<E> addRunOnceListener(Object key,
 Class<E> clazz,
 Runnable listener)

Adds a listener for a specified MultipartEvent that also implements ContextlessEvent with a Runnable.

This makes only one guarantee for event listener ordering: all listeners added for the same key will be called in the order that they are registered.

After the event has been fired once the listener will be removed, which means that the given listener will only be called once (at most).

Parameters:

key - The identifier for the listener, compared with identity equality (==) and not object equality. Multiple listeners can be added with the same key. If the caller is an AbstractPart, and contained within this event bus's getContainer() then it is strongly recommended that the AbstractPart is re-used, because when that part is removed from the MultipartContainer removeListeners(Object) will be called with that part.

clazz - The type of event to listen to.

Throws:

NullPointerException - if any of the arguments are null.

addExternalListener

default <E extends MultipartEvent>
MultipartEventBus.ListenerInfo<E> addExternalListener(Object key,
 Class<E> clazz,
 MultipartEventExternalListener<E> listener)

Adds a listener for a specified MultipartEvent (and all of it's subclasses), but also passes the MultipartContainer that the event was fired from ito the event handler.

This makes only one guarantee for event listener ordering: all listeners added for the same key will be called in the order that they are registered.

Parameters:

key - The identifier for the listener, compared with identity equality (==) and not object equality. Multiple listeners can be added with the same key. If the caller is an AbstractPart, and contained within this event bus's getContainer() then it is strongly recommended that the AbstractPart is re-used, because when that part is removed from the MultipartContainer removeListeners(Object) will be called with that part.

clazz - The type of event to listen to.

Throws:

NullPointerException - if any of the arguments are null.

fireEvent

boolean fireEvent(MultipartEvent event)

Fires the given event to all currently registered listeners.

Returns:

True if any listeners received the given event, false if none did. This may be useful for optimisation purposes.

removeListeners

void removeListeners(Object key)

Removes all listeners that were added for the given key.

getListenersForKey

List<MultipartEventBus.ListenerInfo<? extends MultipartEvent>> getListenersForKey(Object key)

Parameters:

key - The identifier that was used in addListener(Object, Class, EventListener).

Returns:

All listeners that were registered for the given key.

hasAnyListenersForKey

default boolean hasAnyListenersForKey(Object key)

getListeners

<E extends MultipartEvent>
List<? extends MultipartEventBus.ListenerInfo<? extends E>> getListeners(Class<E> clazz)

Returns:

A list of every MultipartEventBus.ListenerInfo that will receive events of the given type.

getAllListeners

List<? extends MultipartEventBus.ListenerInfo<?>> getAllListeners()

Returns:

A list of every MultipartEventBus.ListenerInfo current registered to this event bus.

hasAnyListenersFor

default boolean hasAnyListenersFor(Class<? extends MultipartEvent> clazz)

hasAnyListeners

default boolean hasAnyListeners()