de.skuzzle.jeve

Class FailureCollector

java.lang.Object

de.skuzzle.jeve.FailureCollector

All Implemented Interfaces:

ExceptionCallback, Iterable<FailedEventInvocation>

public final class FailureCollector
extends Object
implements ExceptionCallback, Iterable<FailedEventInvocation>

This class can be used for collecting failed dispatch attempts during event dispatching. This might preferably be used for debugging purposes to locally collect all failed invocations:

 FailureCollector collector = FailedEventsCollecter.create();
 eventProvider.dispatch(myEvent, MyListener::handle, collector);

 for (EventInvocation<?, ?> failed : collector) {
     // ...
 }
 

If you need to notify another ExceptionCallback, you can use the second factory method. The following will collect all failed invocations and also delegate them to the given other ExceptionCallback.

 ExceptionCallback delegate = ...;
 FailureCollector collector = FailedEvents.delegatingTo(delegate);
 ...
 

Since:

3.0.0

Author:

Simon Taddiken

Method Summary

Modifier and Type	Method and Description
static FailureCollector	create() Creates a new FailureCollector.
static FailureCollector	delegatingTo(ExceptionCallback ec) Creates a new FailureCollector which collects every failed notification attempt, then handle the exception with the given delegate ExceptionCallback.
void	exception(FailedEventInvocation invocation) Callback method which is notified about exceptions that may occur during event dispatching.
List<FailedEventInvocation>	getFailedInvocations() Gets the list of failed invocations that has been collected by this collector.
Iterator<FailedEventInvocation>	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.skuzzle.jeve.ExceptionCallback

exception

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

delegatingTo

public static FailureCollector delegatingTo(ExceptionCallback ec)

Creates a new FailureCollector which collects every failed notification attempt, then handle the exception with the given delegate ExceptionCallback.

Parameters:

ec - The delegate.

Returns:

The new FailureCollector.

create

public static FailureCollector create()

Creates a new FailureCollector.

Returns:

The new FailureCollector.

getFailedInvocations

public List<FailedEventInvocation> getFailedInvocations()

Gets the list of failed invocations that has been collected by this collector.

Returns:

The failed invocations.

iterator

public Iterator<FailedEventInvocation> iterator()

Specified by:

iterator in interface Iterable<FailedEventInvocation>

exception

public void exception(FailedEventInvocation invocation)

Description copied from interface: ExceptionCallback

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 ExceptionCallback.exception(Exception, Listener, Event) for compatibility reasons.

Specified by:

exception in interface ExceptionCallback

Parameters:

invocation - FailedEventInvocation object which describes the failure.