de.skuzzle.jeve

Interface DefaultDispatchable

public interface DefaultDispatchable

This interface is ought to be implemented by Event subclasses to provide a simple default dispatch mechanism. Objects implementing this interface can be passed to EventProvider.dispatch(DefaultDispatchable).

Since:

3.0.0

Author:

Simon Taddiken

Method Summary

Modifier and Type	Method and Description
void	defaultDispatch(EventProvider<?> provider, ExceptionCallback ec) Dispatches this event with the given EventProvider using the listener's default listening method.

Method Detail

defaultDispatch

void defaultDispatch(EventProvider<?> provider,
                     ExceptionCallback ec)

Dispatches this event with the given EventProvider using the listener's default listening method. For example, if userAdded is the only listening method (or the default one among others), this method should be implemented as follows:

 @Override
 public void defaultDispatch(EventProvider<?> provider, ExceptionCallback ec) {
     eventProvider.dispatch(this, UserListener::userAdded, ec);
 }
 

This method should not be called directly on an Event object. Instead, pass the event to EventProvider.dispatch(DefaultDispatchable) or EventProvider.dispatch(DefaultDispatchable, ExceptionCallback).

Parameters:

provider - The EventProvider to use for dispatching.

ec - The exception call back to use for this dispatch action.