de.skuzzle.jeve

Interface ExceptionCallback

All Known Implementing Classes:

FailureCollector

public interface ExceptionCallback

Interface for providing errors which occur during event dispatching to the caller.

Since:

1.0.0

Author:

Simon Taddiken

Method Summary

Modifier and Type	Method and Description
default void	exception(Exception e, Listener source, Event<?,?> event) Deprecated. Since 3.0.0 - use exception(FailedEventInvocation) instead.
default void	exception(FailedEventInvocation invocation) Callback method which is notified about exceptions that may occur during event dispatching.

Method Detail

exception

@Deprecated
default void exception(Exception e,
                                    Listener source,
                                    Event<?,?> event)

Deprecated. Since 3.0.0 - use exception(FailedEventInvocation) instead.

Callback method which gets passed an exception. This method will be called by an EventProvider if an instance of this interface has been set as exception callback. This method is generally called within the same thread in which the attempt to notify the listener has been made.

Note: If this method throws any unchecked exceptions other than AbortionException, they will be swallowed by the EventProvider during error handling.

Parameters:

e - The exception which occurred during event dispatching.

source - The event listener which caused the exception.

event - The event which is currently being processed.

Throws:

AbortionException - can be thrown to make event dispatching explicitly fail with an exception. No further listeners will be notified and the caller of dispatch will receive this exception.

exception

default void exception(FailedEventInvocation invocation)

Callback method which is notified about exceptions that may occur during event dispatching. This method will be called by an EventProvider if an instance of this interface has been set as exception callback. This method is generally called within the same thread in which the attempt to notify the listener has been made.

Note: If this method throws any unchecked exceptions other than AbortionException, they will be swallowed by the EventProvider during error handling.

Implementation note: the default implementation calls the deprecated method exception(Exception, Listener, Event) for compatibility reasons.

Parameters:

invocation - FailedEventInvocation object which describes the failure.

Throws:

AbortionException - can be thrown to make event dispatching explicitly fail with an exception. No further listeners will be notified and the caller of dispatch will receive this exception.

Since:

3.0.0