de.skuzzle.jeve

Interface Listener

All Superinterfaces:

EventListener

public interface Listener
extends EventListener

This is the base interface for event listeners. It specifies default methods that are notified when the listener is registered or removed to or from a ListenerStore. Normally, you create an interface extending Listener and add some listening methods. By default, those methods must adhere to the signature:

 public void <listeningName>(<subclass of Event> e);
 

This allows you to provide a method reference conforming to the BiConsumer functional interface to the dispatch method of an EventProvider.

 eventProvider.dispatch(MyListener.class, someEventInstance,
         MyListener::listeningMethod);
 

ListenerInterface Annotation

To enable compile time checks for whether your listener definition adheres to the different kind of listening methods, you may tag it with ListenerInterface. This is completely optional but makes your intentions clear to other programmers.

Since:

1.0.0

Author:

Simon Taddiken

Method Summary

Modifier and Type	Method and Description
default void	onRegister(RegistrationEvent e) This method is called right after this listener has been registered to a new EventProvider.
default void	onUnregister(RegistrationEvent e) This method is called right after this listener has been removed from an EventProvider.

Method Detail

onRegister

default void onRegister(RegistrationEvent e)

This method is called right after this listener has been registered to a new EventProvider. Setting the passed Event's handled attribute to true will have no effect.

Note: The default implementation does nothing.

Parameters:

e - This event object holds the new parent EventProvider and the class for which this listener has been registered.

onUnregister

default void onUnregister(RegistrationEvent e)

This method is called right after this listener has been removed from an EventProvider. If this method throws an unchecked exception, it will be covered by the former EventProvider's ExceptionCallback.

Note: The default implementation does nothing.

Parameters:

e - This event object holds the former parent EventProvider and the class for which this listener has been unregistered.