Package com.helger.commons.callback.exception

Class LoggingExceptionCallback

java.lang.Object

com.helger.commons.callback.exception.LoggingExceptionCallback

All Implemented Interfaces:

IExceptionCallback<Throwable>, ICallback, IHasErrorLevel, IErrorIndicator, ISuccessIndicator

@ThreadSafe
public class LoggingExceptionCallback
extends Object
implements IExceptionCallback<Throwable>, IHasErrorLevel

A specific implementation of the IExceptionCallback interface, that logs all exceptions to a standard logger.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
LoggingExceptionCallback()

Method Summary

Modifier and Type	Method	Description
IErrorLevel	getErrorLevel()
protected String	getLogMessage(Throwable t)	Get the text to be logged for a certain exception
protected boolean	isLogException(Throwable t)	Check if the passed exception should be part of the log entry.
void	onException(Throwable t)	Called when an exception of the specified type occurred.
LoggingExceptionCallback	setErrorLevel(IErrorLevel aErrorLevel)	Set the error level to be used.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.error.level.IHasErrorLevel

hasErrorLevel, isError, isFailure, isNoError, isSuccess

Methods inherited from interface com.helger.commons.state.ISuccessIndicator

and, or

Constructor Detail

LoggingExceptionCallback

public LoggingExceptionCallback()

Method Detail

getErrorLevel

@Nonnull
public IErrorLevel getErrorLevel()

Specified by:

getErrorLevel in interface IHasErrorLevel

Returns:

The configured error level. Never null.

setErrorLevel

@Nonnull
public final LoggingExceptionCallback setErrorLevel(@Nonnull
                                                    IErrorLevel aErrorLevel)

Set the error level to be used.

Parameters:

aErrorLevel - Error level to use. May not be null.

Returns:

this for chaining

getLogMessage

@Nonnull
@Nonempty
@OverrideOnDemand
protected String getLogMessage(@Nullable
                               Throwable t)

Get the text to be logged for a certain exception

Parameters:

t - The exception to be logged. May theoretically be null.

Returns:

The text to be logged. May neither be null nor empty.

isLogException

@OverrideOnDemand
protected boolean isLogException(@Nullable
                                 Throwable t)

Check if the passed exception should be part of the log entry.

Parameters:

t - The exception to check. May theoretically be null.

Returns:

true to log the exception, false to not log it

onException

public void onException(@Nullable
                        Throwable t)

Description copied from interface: IExceptionCallback

Called when an exception of the specified type occurred. You may not re-throw the exception from in here!

Specified by:

onException in interface IExceptionCallback<Throwable>

Parameters:

t - The exception. Never null.

toString

public String toString()

Overrides:

toString in class Object