Package org.incendo.cloud.exception.handling

Interface ExceptionHandler<C,T extends Throwable>

Type Parameters:

C - the command sender type

T - the exception type

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@API(status=STABLE)
public interface ExceptionHandler<C,T extends Throwable>

Handles an exception thrown during command parsing & execution.

Method Summary

Modifier and Type	Method	Description
void	handle(@NonNull ExceptionContext<C,T> context)	Handles the exception in the given context.
static <C, T extends Throwable> @NonNull ExceptionHandler<C,T>	noopHandler()	Returns an exception handler that does nothing.
static <C, T extends Throwable> @NonNull ExceptionHandler<C,T>	passThroughHandler()	Returns an exception handler that re-throws the ExceptionContext.exception().
static <C, T extends Throwable> @NonNull ExceptionHandler<C,T>	passThroughHandler(@NonNull Consumer<ExceptionContext<C,T>> consumer)	Returns an exception handler that re-throws the ExceptionContext.exception() after invoking the given consumer.
static <C, T extends Throwable> @NonNull ExceptionHandler<C,T>	unwrappingHandler()	Returns an exception handler that throws the cause of the ExceptionContext.exception() if it's not null.
static <C, T extends Throwable> @NonNull ExceptionHandler<C,T>	unwrappingHandler(@NonNull Class<? extends Throwable> causeClass)	Returns an exception handler that throws the cause of the ExceptionContext.exception() if it's and instance of causeClass.
static <C, T extends Throwable> @NonNull ExceptionHandler<C,T>	unwrappingHandler(@NonNull Predicate<Throwable> predicate)	Returns an exception handler that throws the cause of the ExceptionContext.exception() if it's not null and the predicate evaluates to true.

Method Details

noopHandler

static <C,
T extends Throwable>
@NonNull ExceptionHandler<C,T> noopHandler()

Returns an exception handler that does nothing.

Type Parameters:

C - the command sender type

T - the exception type

Returns:

the exception handler

passThroughHandler

static <C,
T extends Throwable>
@NonNull ExceptionHandler<C,T> passThroughHandler()

Returns an exception handler that re-throws the ExceptionContext.exception().

This will allow other exception handlers to handle the exception.

Type Parameters:

C - the command sender type

T - the exception type

Returns:

the exception handler

passThroughHandler

static <C,
T extends Throwable>
@NonNull ExceptionHandler<C,T> passThroughHandler(@NonNull Consumer<ExceptionContext<C,T>> consumer)

Returns an exception handler that re-throws the ExceptionContext.exception() after invoking the given consumer.

Type Parameters:

C - the command sender type

T - the exception type

Parameters:

consumer - the consumer

Returns:

the exception handler

unwrappingHandler

static <C,
T extends Throwable>
@NonNull ExceptionHandler<C,T> unwrappingHandler(@NonNull Predicate<Throwable> predicate)

Returns an exception handler that throws the cause of the ExceptionContext.exception() if it's not null and the predicate evaluates to true. Otherwise, it will re-throw the ExceptionContext.exception().

Type Parameters:

C - the command sender type

T - the exception type

Parameters:

predicate - predicate that tests the cause of the exception

Returns:

the exception handler

unwrappingHandler

static <C,
T extends Throwable>
@NonNull ExceptionHandler<C,T> unwrappingHandler(@NonNull Class<? extends Throwable> causeClass)

Returns an exception handler that throws the cause of the ExceptionContext.exception() if it's and instance of causeClass. Otherwise, it will re-throw the ExceptionContext.exception().

Type Parameters:

C - the command sender type

T - the exception type

Parameters:

causeClass - the type of the cause

Returns:

the exception handler

unwrappingHandler

static <C,
T extends Throwable>
@NonNull ExceptionHandler<C,T> unwrappingHandler()

Returns an exception handler that throws the cause of the ExceptionContext.exception() if it's not null. Otherwise, it will re-throw the ExceptionContext.exception().

Type Parameters:

C - the command sender type

T - the exception type

Returns:

the exception handler

handle

void handle(@NonNull ExceptionContext<C,T> context)
     throws Throwable

Handles the exception in the given context.

Any exception thrown by the handler will be handled by the ExceptionController.

If the ExceptionContext.exception() is re-thrown, then the next exception handler in line will get to handle the exception instead.

Parameters:

context - the exception context

Throws:

Exception - any exception thrown by the handler

Throwable