de.skuzzle.jeve.invoke

Interface EventInvocation

All Known Subinterfaces:

FailedEventInvocation

public interface EventInvocation

Represents the action of notifying a single listener about an event. The notification can be triggered with notifyListener(). If the notification fails because the listener throws an exception, this invocation will be converted into a FailedEventInvocation and passed to ExceptionCallback.exception(FailedEventInvocation).

Since:

3.0.0

Author:

Simon Taddiken

Method Summary

Modifier and Type	Method and Description
FailedEventInvocation	fail(Exception e) Creates a new FailedEventInvocation holding the given exception.
Event<?,?>	getEvent() Gets the event to notify the listener about.
Listener	getListener() Gets the listener which is notified.
void	notifyListener() Notifies the wrapped listener about the wrapped event.
static <L extends Listener,E extends Event<?,L>> EventInvocation	of(L listener, E event, BiConsumer<L,E> method, ExceptionCallback ec) Creates a new EventInvocation.

Method Detail

of

static <L extends Listener,E extends Event<?,L>> EventInvocation of(L listener,
                                                                    E event,
                                                                    BiConsumer<L,E> method,
                                                                    ExceptionCallback ec)

Creates a new EventInvocation.

Type Parameters:

L - The type of the listener.

E - The type of the event.

Parameters:

listener - The listener to notify.

event - The event to pass to the listener.

method - The method of the listener to call.

ec - The exception handler.

Returns:

A new EventInvocation for notifying the given listener with given event.

getEvent

Event<?,?> getEvent()

Gets the event to notify the listener about.

Returns:

The event.

getListener

Listener getListener()

Gets the listener which is notified.

Returns:

The listener.

notifyListener

void notifyListener()

Notifies the wrapped listener about the wrapped event. This method performs all the exception handling described in EventProvider and ExceptionCallback.

fail

FailedEventInvocation fail(Exception e)

Creates a new FailedEventInvocation holding the given exception.

Parameters:

e - The exception which occurred while notifying the listener.

Returns:

A new FailedEventInvocation.