net.openhft.chronicle.core.onoes

Interface ExceptionHandler

All Known Implementing Classes:

ChainedExceptionHandler, NullExceptionHandler, RecordingExceptionHandler, Slf4jExceptionHandler, ThreadLocalisedExceptionHandler

Functional Interface:

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

@FunctionalInterface
public interface ExceptionHandler

Strategy interface for pluggable exception handling, suitable for use with lambdas.

The overloads delegate to on(Class, String, Throwable). Implementations must be non-blocking and re-entrant.

See Also:

NullExceptionHandler, Slf4jExceptionHandler

Method Summary

Modifier and Type	Method and Description
default ExceptionHandler	defaultHandler() Retrieves the default underlying exception handler.
static ExceptionHandler	ignoresEverything() Creates an ExceptionHandler that ignores all exceptions.
default boolean	isEnabled(@NotNull Class<?> aClass) Checks if the exception handler is enabled for the given class.
default void	on(@NotNull Class<?> clazz, String message) Convenience overload delegating to on(Class, String, Throwable) with a null throwable.
default void	on(@NotNull Class<?> clazz, @Nullable String message, @Nullable Throwable thrown) Handles an exception for the given class, message and throwable.
default void	on(@NotNull Class<?> clazz, Throwable thrown) Convenience overload delegating to on(Class, String, Throwable) with an empty message.
default void	on(@NotNull org.slf4j.Logger logger, @Nullable String message) Convenience overload delegating to on(Logger, String, Throwable) with a null throwable.
void	on(@NotNull org.slf4j.Logger logger, @Nullable String message, @Nullable Throwable thrown) Handles an exception with the given logger, message and throwable.

Method Detail

ignoresEverything

static ExceptionHandler ignoresEverything()

Creates an ExceptionHandler that ignores all exceptions.

Returns:

an instance of NullExceptionHandler which ignores all exceptions.

on

default void on(@NotNull
                @NotNull Class<?> clazz,
                Throwable thrown)

Convenience overload delegating to on(Class, String, Throwable) with an empty message.

Parameters:

clazz - the class where the error occurred

thrown - the throwable instance representing the error, may be null

Throws:

NullPointerException - if clazz is null

on

default void on(@NotNull
                @NotNull Class<?> clazz,
                String message)

Convenience overload delegating to on(Class, String, Throwable) with a null throwable.

Parameters:

clazz - the class where the error occurred

message - a custom message detailing the error, may be null

Throws:

NullPointerException - if clazz is null

on

default void on(@NotNull
                @NotNull Class<?> clazz,
                @Nullable
                @Nullable String message,
                @Nullable
                @Nullable Throwable thrown)

Handles an exception for the given class, message and throwable. If logging fails this method attempts to log again at Slf4jExceptionHandler.ERROR level.

Parameters:

clazz - the class where the exception occurred

message - a custom message providing additional information or null

thrown - the exception that needs to be handled, may be null

Throws:

NullPointerException - if clazz is null

on

void on(@NotNull
        @NotNull org.slf4j.Logger logger,
        @Nullable
        @Nullable String message,
        @Nullable
        @Nullable Throwable thrown)

Handles an exception with the given logger, message and throwable.

Parameters:

logger - the logger used to record the error

message - a custom message detailing the error, may be null

thrown - the throwable instance representing the error, may be null

Throws:

NullPointerException - if logger is null

on

default void on(@NotNull
                @NotNull org.slf4j.Logger logger,
                @Nullable
                @Nullable String message)

Convenience overload delegating to on(Logger, String, Throwable) with a null throwable.

Parameters:

logger - the logger used to record the error

message - a custom message detailing the error, may be null

Throws:

NullPointerException - if logger is null

isEnabled

default boolean isEnabled(@NotNull
                          @NotNull Class<?> aClass)

Checks if the exception handler is enabled for the given class.

Parameters:

aClass - the class to test

Returns:

true if this handler should be invoked for the class

Throws:

NullPointerException - if aClass is null

defaultHandler

default ExceptionHandler defaultHandler()

Retrieves the default underlying exception handler.

Returns:

the default exception handler, usually this