public class UIMAException extends Exception implements I18nExceptionI
UIMAException
extends InternationalizedException
for internationalization
support. Since UIMA Exceptions are internationalized, the thrower does not supply a hardcoded
message. Instead, the thrower specifies a key that identifies the message. That key is then
looked up in a locale-specific ResourceBundle
to find the actual
message associated with this exception.
The thrower may specify the name of the ResourceBundle
in which to find the
exception message. Any name may be used. If the name is omitted, the resource bundle identified
by STANDARD_MESSAGE_CATALOG
will be used. This contains the standard UIMA exception
messages.
Modifier and Type | Field and Description |
---|---|
static String |
STANDARD_MESSAGE_CATALOG
The name of the
ResourceBundle containing the standard UIMA
Exception messages. |
Constructor and Description |
---|
UIMAException()
Creates a new exception with a null message.
|
UIMAException(String aMessageKey,
Object[] aArguments)
Creates a new exception with a message from the
STANDARD_MESSAGE_CATALOG . |
UIMAException(String aMessageKey,
Object[] aArguments,
Throwable aCause)
Creates a new exception with the specified cause and a message from the
STANDARD_MESSAGE_CATALOG . |
UIMAException(String aResourceBundleName,
String aMessageKey,
Object... aArguments)
Creates a new exception with a the specified message.
|
UIMAException(String aResourceBundleName,
String aMessageKey,
Object[] aArguments,
Throwable aCause)
Creates a new exception with the specified message and cause.
|
UIMAException(Throwable aCause)
Creates a new exception with the specified cause and a null message.
|
Modifier and Type | Method and Description |
---|---|
Object[] |
getArguments()
Gets the arguments to this exception's message.
|
Throwable |
getCause()
Gets the cause of this Exception.
|
String |
getLocalizedMessage()
Gets the localized detail message for this exception.
|
String |
getMessage()
Due to the fact that superclass definitions override any
default methods, these next must be in the class definitions
as they override other supertype methods.
|
String |
getMessageKey()
Gets the identifier for this exception's message.
|
String |
getResourceBundleName()
Gets the base name of the resource bundle in which the message for this
exception is located.
|
Throwable |
initCause(Throwable cause) |
addSuppressed, fillInStackTrace, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getLocalizedMessage, hasMessageKey
public static final String STANDARD_MESSAGE_CATALOG
ResourceBundle
containing the standard UIMA
Exception messages.public UIMAException()
public UIMAException(Throwable aCause)
aCause
- the original exception that caused this exception to be thrown, if anypublic UIMAException(String aResourceBundleName, String aMessageKey, Object... aArguments)
aResourceBundleName
- the base name of the resource bundle in which the message for this exception is
located.aMessageKey
- an identifier that maps to the message for this exception. The message may contain
placeholders for arguments as defined by the
MessageFormat
class.aArguments
- The arguments to the message. null
may be used if the message has no
arguments.public UIMAException(String aResourceBundleName, String aMessageKey, Object[] aArguments, Throwable aCause)
aResourceBundleName
- the base name of the resource bundle in which the message for this exception is
located.aMessageKey
- an identifier that maps to the message for this exception. The message may contain
placeholders for arguments as defined by the
MessageFormat
class.aArguments
- The arguments to the message. null
may be used if the message has no
arguments.aCause
- the original exception that caused this exception to be thrown, if anypublic UIMAException(String aMessageKey, Object[] aArguments)
STANDARD_MESSAGE_CATALOG
.aMessageKey
- an identifier that maps to the message for this exception. The message may contain
placeholders for arguments as defined by the
MessageFormat
class.aArguments
- The arguments to the message. null
may be used if the message has no
arguments.public UIMAException(String aMessageKey, Object[] aArguments, Throwable aCause)
STANDARD_MESSAGE_CATALOG
.aMessageKey
- an identifier that maps to the message for this exception. The message may contain
placeholders for arguments as defined by the
MessageFormat
class.aArguments
- The arguments to the message. null
may be used if the message has no
arguments.aCause
- the original exception that caused this exception to be thrown, if anypublic Throwable getCause()
getCause
in interface I18nExceptionI
getCause
in class Throwable
null
if there is no such cause.public String getResourceBundleName()
getResourceBundleName
in interface I18nExceptionI
null
if
this exception has no message.public String getMessageKey()
ResourceBundle
to get the locale-specific
message for this exception.getMessageKey
in interface I18nExceptionI
null
if this exception has no message.public Object[] getArguments()
InternationalizedException
to have a compound message, made
up of multiple parts that are concatenated in a language-neutral way.getArguments
in interface I18nExceptionI
public String getMessage()
I18nExceptionI
getMessage
in interface I18nExceptionI
getMessage
in class Throwable
public String getLocalizedMessage()
I18nExceptionI.getLocalizedMessage(Locale)
.getLocalizedMessage
in interface I18nExceptionI
getLocalizedMessage
in class Throwable
Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.