org.mule.runtime.privileged.exception

Class SuppressedMuleException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.mule.runtime.api.exception.MuleException

org.mule.runtime.privileged.exception.SuppressedMuleException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SuppressedMuleException

public class SuppressedMuleException
extends MuleException

Wraps a provided exception, suppressing a MuleException that is part of it's cause tree, meaning that the Mule Runtime will not take it into account for the error handling. The suppressed cause and all its nested Throwable.getCause() will not be taken into account during the Error resolution.

Example without suppression:

 throw new TypedException(new ConnectionException(), customErrorType)
 

will resolve to an Error with Error.getErrorType() returning ConnectionException's error type (discarding the top level customErrorType).

Same example with suppression:

 throw new TypedException(new SuppressedMuleException(new ConnectionException()), customErrorType)
 

will resolve to an Error with Error.getErrorType() returning customErrorType (discarding the underlying ConnectionException's error type}).

Since:

1.2.3, 1.3

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mule.runtime.api.exception.MuleException

EXCEPTION_MESSAGE_DELIMITER, EXCEPTION_MESSAGE_SECTION_DELIMITER, INFO_ALREADY_LOGGED_KEY, INFO_ERROR_TYPE_KEY, INFO_LOCATION_KEY, INFO_SOURCE_XML_KEY, MISSING_DEFAULT_VALUE, MULE_VERBOSE_EXCEPTIONS, verboseExceptions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SuppressedMuleException(Throwable throwable, MuleException causeToSuppress) Constructs a new SuppressedMuleException

Method Summary

Modifier and Type	Method and Description
String	getSummaryMessage()
MuleException	getSuppressedException()
String	getVerboseMessage()
static Throwable	suppressIfPresent(Throwable exception, Class<? extends MuleException> causeToSuppress) Wraps the provided exception, suppressing the exception itself or the first cause that is an instance of the provided class.
Throwable	unwrap() Unwraps a SuppressedMuleException.

Methods inherited from class org.mule.runtime.api.exception.MuleException

addAllInfo, addInfo, appendMessage, equals, getAdditionalInfo, getDetailedMessage, getExceptionInfo, getI18nMessage, getInfo, getMessage, getMessageCode, hashCode, isVerboseExceptions, prependMessage, refreshVerboseExceptions, setMessage, setMessage

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SuppressedMuleException

protected SuppressedMuleException(Throwable throwable,
                                  MuleException causeToSuppress)

Constructs a new SuppressedMuleException

Parameters:

throwable - Exception that will be wrapped.

causeToSuppress - The cause that wants to be suppressed. Cannot be null.

Method Detail

unwrap

public Throwable unwrap()

Unwraps a SuppressedMuleException.

Returns:

First cause that is not an instance of SuppressedMuleException.

getSuppressedException

public MuleException getSuppressedException()

Returns:

MuleException that has been suppressed by this SuppressedMuleException.

suppressIfPresent

public static Throwable suppressIfPresent(Throwable exception,
                                          Class<? extends MuleException> causeToSuppress)

Wraps the provided exception, suppressing the exception itself or the first cause that is an instance of the provided class. The search will stop if a SuppressedMuleException is found, making no suppression.

Parameters:

exception - Exception that will be wrapped, suppressing the exception itself or one of it's causes.

causeToSuppress - Class of the MuleException that has to be suppressed.

Returns:

SuppressedMuleException or provided exception if no cause to suppress is found.

getVerboseMessage

public String getVerboseMessage()

Overrides:

getVerboseMessage in class MuleException

getSummaryMessage

public String getSummaryMessage()

Overrides:

getSummaryMessage in class MuleException