org.swblocks.jbl.eh

Class BaseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.swblocks.jbl.eh.BaseException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PropertiesHolderException

public class BaseException
extends java.lang.RuntimeException

The base exception class for all exceptions.

It provides basic support for capture of basic core properties and subsequent enhancement with other properties, including custom properties

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	BaseException(java.lang.String message) See documentation for RuntimeException.RuntimeException(String).
	BaseException(java.lang.String message, java.lang.Throwable cause) See documentation for RuntimeException.RuntimeException(String, Throwable).
protected	BaseException(java.lang.Throwable referenceExceptionToChain, java.lang.String message, java.lang.Throwable cause) A protected constructor (that allows referenceException to be set) to be used only by the derived types (if necessary).

Method Summary

Modifier and Type	Method and Description
java.lang.StackTraceElement	getCallerFrame() Gets the caller frame.
<R> R	getExceptionDetails(java.util.function.Function<java.lang.StringBuffer,R> callback) * Obtains the exception details dump, including all properties, for an exception.
java.lang.String	getExceptionDetailsAsString() Obtains the exception details dump, including all properties, for an exception as string.
java.time.Instant	getTimeThrown() Gets the time at which the exception was thrown.
void	printExceptionDetails(java.io.PrintStream printStream) Obtains the exception details dump, including all properties, for an exception into a print stream.
void	printExceptionDetails(java.io.PrintWriter printWriter) Obtains the exception details dump, including all properties, for an exception into a print writer.
void	putProperty(java.lang.String name, java.lang.Object value) Appends or removes property to the exception details.
<E> E	tryGetProperty(java.lang.String name) Gets property from the exception by name.
java.lang.String	tryGetPropertyAsString(java.lang.String name) Gets property of the exception as string.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseException

protected BaseException(java.lang.Throwable referenceExceptionToChain,
                        java.lang.String message,
                        java.lang.Throwable cause)

A protected constructor (that allows referenceException to be set) to be used only by the derived types (if necessary).

See also documentation for RuntimeException.RuntimeException(String, Throwable)

Parameters:

referenceExceptionToChain - Exception that is chained to this base exception

message - See documentation for RuntimeException.RuntimeException(String)

cause - See documentation for RuntimeException.RuntimeException(Throwable)

BaseException

public BaseException(java.lang.String message)

See documentation for RuntimeException.RuntimeException(String).

Parameters:

message - See documentation for RuntimeException.RuntimeException(String)

BaseException

public BaseException(java.lang.String message,
                     java.lang.Throwable cause)

See documentation for RuntimeException.RuntimeException(String, Throwable).

Parameters:

message - See documentation for RuntimeException.RuntimeException(String)

cause - See documentation for RuntimeException.RuntimeException(Throwable)

Method Detail

getTimeThrown

public java.time.Instant getTimeThrown()

Gets the time at which the exception was thrown.

Returns:

The time at which it was thrown

getCallerFrame

public java.lang.StackTraceElement getCallerFrame()

Gets the caller frame.

Returns:

The caller frame

putProperty

public void putProperty(java.lang.String name,
                        java.lang.Object value)

Appends or removes property to the exception details. The name parameter is expected to not be null or empty. However the value parameter can be null in which case all properties associated with that property name will be removed from the exception.

Parameters:

name - The name of the exception property (could be one of the core properties in EhCoreProperties) or other value. It cannot be null or empty.

value - The value of the property. If value is null all properties associated with that property name will be removed.

tryGetProperty

public <E> E tryGetProperty(java.lang.String name)

Gets property from the exception by name. If multiple properties were appended the last one will be returned.

Type Parameters:

E - The expected type

Parameters:

name - The name of the exception property (could be one of the core properties in EhCoreProperties)

Returns:

The property value

tryGetPropertyAsString

public java.lang.String tryGetPropertyAsString(java.lang.String name)

Gets property of the exception as string.

Parameters:

name - The name of the exception property (could be one of the core properties in EhCoreProperties)

Returns:

The property value

getExceptionDetails

public <R> R getExceptionDetails(java.util.function.Function<java.lang.StringBuffer,R> callback)

* Obtains the exception details dump, including all properties, for an exception.

Type Parameters:

R - The return type of the callback (if any)

Parameters:

callback - The callback invoked with the string buffer

Returns:

The same as the return value from the callback

getExceptionDetailsAsString

public java.lang.String getExceptionDetailsAsString()

Obtains the exception details dump, including all properties, for an exception as string.

Returns:

The exception details as string

printExceptionDetails

public void printExceptionDetails(java.io.PrintWriter printWriter)

Obtains the exception details dump, including all properties, for an exception into a print writer.

Parameters:

printWriter - The print writer where to store them

printExceptionDetails

public void printExceptionDetails(java.io.PrintStream printStream)

Obtains the exception details dump, including all properties, for an exception into a print stream.

Parameters:

printStream - The print stream where to store them