net.kyori.event

Class PostResult

java.lang.Object

net.kyori.event.PostResult

public final class PostResult
extends java.lang.Object

Encapsulates the outcome of a EventBus.post(Object) call.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PostResult.CompositeException Exception encapsulating a combined failure.

Method Summary

Modifier and Type	Method and Description
@NonNull java.util.Map<EventSubscriber<?>,java.lang.Throwable>	exceptions() Gets the exceptions that were thrown whilst posting the event to subscribers.
static @NonNull PostResult	failure(@NonNull java.util.Map<EventSubscriber<?>,java.lang.Throwable> exceptions) Marks that exceptions were thrown by subscribers.
void	raise() Raises a PostResult.CompositeException if the posting was not successful.
static @NonNull PostResult	success() Marks that no exceptions were thrown by subscribers.
java.lang.String	toString()
boolean	wasSuccessful() Gets if the EventBus.post(Object) call was successful.

Methods inherited from class java.lang.Object

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

Method Detail

success

public static @NonNull PostResult success()

Marks that no exceptions were thrown by subscribers.

Returns:

a PostResult indicating success

failure

public static @NonNull PostResult failure(@NonNull java.util.Map<EventSubscriber<?>,java.lang.Throwable> exceptions)

Marks that exceptions were thrown by subscribers.

Parameters:

exceptions - the exceptions that were thrown

Returns:

a PostResult indicating failure

wasSuccessful

public boolean wasSuccessful()

Gets if the EventBus.post(Object) call was successful.

Returns:

if the call was successful

exceptions

public @NonNull java.util.Map<EventSubscriber<?>,java.lang.Throwable> exceptions()

Gets the exceptions that were thrown whilst posting the event to subscribers.

Returns:

the exceptions thrown by subscribers

raise

public void raise()
           throws PostResult.CompositeException

Raises a PostResult.CompositeException if the posting was not successful.

Throws:

PostResult.CompositeException - if posting was not successful

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object