net.sf.mmm.util.exception.api

Class ExceptionTruncation

java.lang.Object

net.sf.mmm.util.exception.api.ExceptionTruncation

public class ExceptionTruncation
extends Object

This class configures the (potential) truncation of an exception. A truncation includes the following aspects:

• remove cause
• remove stacktrace
• remove suppressed exceptions

Since:

4.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static ExceptionTruncation	REMOVE_ALL Instance to remove all additional details.
static ExceptionTruncation	REMOVE_NONE Instance to remove no additional details.
static ExceptionTruncation	REMOVE_STACKTRACE_AND_SUPPRESSED Instance to remove stacktrace and suppressed.
private boolean	removeCause
private boolean	removeStacktrace
private boolean	removeSuppressed

Constructor Summary

Constructors

Constructor and Description
ExceptionTruncation(boolean removeSuppressed, boolean removeCause, boolean removeStacktrace) The constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isRemoveAll()
boolean	isRemoveCause()
boolean	isRemoveStacktrace()
boolean	isRemoveSuppressed()
boolean	isRetainAll()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

REMOVE_ALL

public static final ExceptionTruncation REMOVE_ALL

Instance to remove all additional details.

REMOVE_STACKTRACE_AND_SUPPRESSED

public static final ExceptionTruncation REMOVE_STACKTRACE_AND_SUPPRESSED

Instance to remove stacktrace and suppressed.

REMOVE_NONE

public static final ExceptionTruncation REMOVE_NONE

Instance to remove no additional details.

removeCause

private final boolean removeCause

removeSuppressed

private final boolean removeSuppressed

removeStacktrace

private final boolean removeStacktrace

Constructor Detail

ExceptionTruncation

public ExceptionTruncation(boolean removeSuppressed,
                           boolean removeCause,
                           boolean removeStacktrace)

The constructor.

Parameters:

removeSuppressed - - see isRemoveSuppressed().

removeCause - - see isRemoveCause().

removeStacktrace - - see isRemoveStacktrace().

Method Detail

isRemoveSuppressed

public boolean isRemoveSuppressed()

Returns:

true if the suppressed exceptions shall be removed, false otherwise.

isRemoveCause

public boolean isRemoveCause()

Returns:

true if the cause shall be removed, false otherwise.

isRemoveStacktrace

public boolean isRemoveStacktrace()

Returns:

true if the stacktrace shall be removed, false otherwise.

isRemoveAll

public boolean isRemoveAll()

Returns:

true if all details shall be removed, false otherwise.

See Also:

isRemoveStacktrace(), isRemoveCause(), isRemoveSuppressed()

isRetainAll

public boolean isRetainAll()

Returns:

true if no details shall be removed (all information is retained), false otherwise.

See Also:

isRemoveStacktrace(), isRemoveCause(), isRemoveSuppressed()

toString

public String toString()

Overrides:

toString in class Object