net.openhft.chronicle.core.onoes

Class ThreadLocalisedExceptionHandler

java.lang.Object

net.openhft.chronicle.core.onoes.ThreadLocalisedExceptionHandler

All Implemented Interfaces:

ExceptionHandler

public class ThreadLocalisedExceptionHandler
extends Object
implements ExceptionHandler

This class provides a thread-localized ExceptionHandler. The actual ExceptionHandler used for handling exceptions can vary per thread and can be configured using the threadLocalHandler method. If no thread-local ExceptionHandler has been set, it will fall back to a default ExceptionHandler.

The default ExceptionHandler can be set using the defaultHandler method, and is initially passed to the constructor when creating a new instance of this class.

Constructor Summary

Constructors

Constructor and Description
ThreadLocalisedExceptionHandler(ExceptionHandler handler)

Method Summary

Modifier and Type	Method and Description
ExceptionHandler	defaultHandler()
ThreadLocalisedExceptionHandler	defaultHandler(ExceptionHandler defaultHandler)
boolean	isEnabled(@NotNull Class<?> aClass) Checks if the exception handler is enabled for the given class.
void	on(@NotNull Class<?> clazz, @Nullable String message, @Nullable Throwable thrown) The default method to call when an exception occurs.
void	on(@NotNull org.slf4j.Logger logger, @Nullable String message, Throwable thrown) Handles an exception occurred with a specific logger, message and throwable.
void	resetThreadLocalHandler()
ExceptionHandler	threadLocalHandler()
ThreadLocalisedExceptionHandler	threadLocalHandler(ExceptionHandler handler)
static ExceptionHandler	unwrap(ExceptionHandler eh)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.core.onoes.ExceptionHandler

ignoresEverything, on, on, on

Constructor Detail

ThreadLocalisedExceptionHandler

public ThreadLocalisedExceptionHandler(ExceptionHandler handler)

Method Detail

on

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

Description copied from interface: ExceptionHandler

The default method to call when an exception occurs. It tries to log the exception and if it fails, it falls back to a secondary logging mechanism.

Specified by:

on in interface ExceptionHandler

Parameters:

clazz - the class where the error occurred. Must not be null.

message - a custom message detailing the error, or an empty string.

thrown - the throwable instance representing the error, or null if there was no exception.

on

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

Description copied from interface: ExceptionHandler

Handles an exception occurred with a specific logger, message and throwable.

Specified by:

on in interface ExceptionHandler

Parameters:

logger - the logger instance to log the error. Must not be null.

message - a custom message detailing the error, or null.

thrown - the throwable instance representing the error, or null.

defaultHandler

public ExceptionHandler defaultHandler()

Specified by:

defaultHandler in interface ExceptionHandler

Returns:

the default underlying exception handler.

unwrap

public static ExceptionHandler unwrap(ExceptionHandler eh)

defaultHandler

public ThreadLocalisedExceptionHandler defaultHandler(ExceptionHandler defaultHandler)

threadLocalHandler

public ExceptionHandler threadLocalHandler()

threadLocalHandler

public ThreadLocalisedExceptionHandler threadLocalHandler(ExceptionHandler handler)

resetThreadLocalHandler

public void resetThreadLocalHandler()

isEnabled

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

Description copied from interface: ExceptionHandler

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

Specified by:

isEnabled in interface ExceptionHandler

Parameters:

aClass - the class to check if the exception handler is enabled for. Must not be null.

Returns:

true, as the exception handler is enabled by default for all classes.