Package org.apache.sis.util
Class Exceptions
Static methods working with
Exception
instances.- Since:
- 0.3
Defined in the sis-utility
module
-
Method Summary
Modifier and TypeMethodDescriptionstatic String
formatChainedMessages
(Locale locale, String header, Throwable cause) Returns a string which contains the given message on the first line, followed by the localized message of the given exception on the next line.static String
getLocalizedMessage
(Throwable exception, Locale locale) Returns the message of the given exception, localized in the given locale if possible.static boolean
messageEquals
(Throwable first, Throwable second) Returnstrue
if the given exceptions are of the same class and contains the same message.static <T extends Throwable>
TsetMessage
(T exception, String message, boolean append) Deprecated.To be removed with no replacement.static Exception
If the given exception is a wrapper for another exception, returns the unwrapped exception.
-
Method Details
-
getLocalizedMessage
Returns the message of the given exception, localized in the given locale if possible. Some exceptions created by SIS can format a message in different locales. This method returns such localized message if possible, or fallback on the standard JDK methods otherwise. More specifically:- If the given
exception
is null, then this method returnsnull
. - Otherwise if the given
locale
is null, then this method returnsThrowable.getMessage()
. This is consistent with theLocalized
policy saying that null locale stands for "unlocalized" message (usually in English) or message in the JVM default locale. - Otherwise if the given
exception
is an instance ofLocalizedException
providing a non-null international message, then this method returns the result ofInternationalString.toString(Locale)
. - Otherwise this method returns
Throwable.getLocalizedMessage()
.
- Parameters:
exception
- the exception from which to get the localize message, ornull
.locale
- the preferred locale for the message, ornull
for the JVM default locale. This locale is honored on a best-effort basis only.- Returns:
- the message in the given locale if possible, or
null
if theexception
argument wasnull
or if the exception does not contain a message. - See Also:
- If the given
-
setMessage
@Deprecated public static <T extends Throwable> T setMessage(T exception, String message, boolean append) Deprecated.To be removed with no replacement.Returns an exception of the same kind and with the same stack trace than the given exception, but with a different message. This method simulates the functionality that we would have ifThrowable
defined asetMessage(String)
method. We use this method when an external library throws an exception of the right type, but with too few details.This method tries to create a new exception using reflection. The exception class needs to provide a public constructor expecting a single
String
argument. If the exception class does not provide such constructor, then the given exception is returned unchanged.- Type Parameters:
T
- the type of the exception.- Parameters:
exception
- the exception to copy with a different message.message
- the message to set in the exception to be returned.append
- iftrue
, the existing message in the original exception (if any) will be happened after the provided message.- Returns:
- a new exception with the given message, or the given exception if the exception
class does not provide public
Exception(String)
constructor.
-
messageEquals
Returnstrue
if the given exceptions are of the same class and contains the same message. This method does not compare the stack trace, cause or suppressed exceptions.- Parameters:
first
- the first exception, ornull
.second
- the second exception, ornull
.- Returns:
true
if both exceptions arenull
, or both exceptions are non-null, of the same class and with the same message.- Since:
- 1.0
-
formatChainedMessages
Returns a string which contains the given message on the first line, followed by the localized message of the given exception on the next line. If the exception has a causes, then the class name and the localized message of the cause are formatted on the next line and the process is repeated for the whole cause chain, omitting duplicated messages.SQLException
is handled especially in order to process the next exception instead of the cause.This method does not format the stack trace.
- Parameters:
locale
- the preferred locale for the exception message, ornull
.header
- the message to insert on the first line, ornull
if none.cause
- the exception, ornull
if none.- Returns:
- the formatted message, or
null
if both the header wasnull
and no exception provide a message.
-
unwrap
If the given exception is a wrapper for another exception, returns the unwrapped exception. Otherwise returns the given argument unchanged. An exception is considered a wrapper if:- It is an instance of
InvocationTargetException
(could be wrapping anything). - It is an instance of
ExecutionException
(could be wrapping anything). - It is an instance of
BackingStoreException
(typically wrapping a checked exception). - It is an instance of
UncheckedIOException
(wrapping aIOException
). - It is an instance of
DirectoryIteratorException
(wrapping aIOException
). - It is a parent type of the cause. For example some JDBC drivers wrap
SQLException
in otherSQLException
without additional information.
Note:This method uses only the exception class and the absence of suppressed exceptions as criterion; it does not verify if the exception messages are the same.PrivilegedActionException
is also a wrapper exception, but is not included in above list because it is used in very specific contexts. Furthermore classes related to security manager are deprecated since Java 17.- Parameters:
exception
- the exception to unwrap (may benull
.- Returns:
- the unwrapped exception (may be the given argument itself).
- Since:
- 0.8
- It is an instance of
-