Package org.apache.uima
Class UIMAException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- org.apache.uima.UIMAException
-
- All Implemented Interfaces:
java.io.Serializable
,I18nExceptionI
- Direct Known Subclasses:
AnnotatorConfigurationException
,AnnotatorContextException
,AnnotatorInitializationException
,AnnotatorProcessException
,CASException
,CollectionException
,IndexingException
,InvalidXMLException
,ResourceAccessException
,ResourceConfigurationException
,ResourceInitializationException
,ResourceProcessException
,ResourceServiceException
,ResultNotSupportedException
public class UIMAException extends java.lang.Exception implements I18nExceptionI
This is the superclass for all checked exceptions in UIMA. It adds use of a "standard" bundle resource, if the subclasses don't define this.UIMAException
extendsInternationalizedException
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-specificResourceBundle
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 bySTANDARD_MESSAGE_CATALOG
will be used. This contains the standard UIMA exception messages.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.Object[]
mArguments
The arguments to this exception's message, if any.private java.lang.Throwable
mCause
The exception that caused this exception to occur.private java.lang.String
mMessageKey
An identifier that maps to the message for this exception.private java.lang.String
mResourceBundleName
The base name of the resource bundle in which the message for this exception is located.private static long
serialVersionUID
static java.lang.String
STANDARD_MESSAGE_CATALOG
The name of theResourceBundle
containing the standard UIMA Exception messages.
-
Constructor Summary
Constructors Constructor Description UIMAException()
Creates a new exception with a null message.UIMAException(java.lang.String aMessageKey, java.lang.Object[] aArguments)
Creates a new exception with a message from theSTANDARD_MESSAGE_CATALOG
.UIMAException(java.lang.String aMessageKey, java.lang.Object[] aArguments, java.lang.Throwable aCause)
Creates a new exception with the specified cause and a message from theSTANDARD_MESSAGE_CATALOG
.UIMAException(java.lang.String aResourceBundleName, java.lang.String aMessageKey, java.lang.Object... aArguments)
Creates a new exception with a the specified message.UIMAException(java.lang.String aResourceBundleName, java.lang.String aMessageKey, java.lang.Object[] aArguments, java.lang.Throwable aCause)
Creates a new exception with the specified message and cause.UIMAException(java.lang.Throwable aCause)
Creates a new exception with the specified cause and a null message.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object[]
getArguments()
Gets the arguments to this exception's message.java.lang.Throwable
getCause()
Gets the cause of this Exception.java.lang.String
getLocalizedMessage()
Gets the localized detail message for this exception.java.lang.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.java.lang.String
getMessageKey()
Gets the identifier for this exception's message.java.lang.String
getResourceBundleName()
Gets the base name of the resource bundle in which the message for this exception is located.java.lang.Throwable
initCause(java.lang.Throwable cause)
-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.uima.I18nExceptionI
getLocalizedMessage, hasMessageKey
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
STANDARD_MESSAGE_CATALOG
public static final java.lang.String STANDARD_MESSAGE_CATALOG
The name of theResourceBundle
containing the standard UIMA Exception messages.- See Also:
- Constant Field Values
-
mResourceBundleName
private java.lang.String mResourceBundleName
The base name of the resource bundle in which the message for this exception is located.
-
mMessageKey
private java.lang.String mMessageKey
An identifier that maps to the message for this exception.
-
mArguments
private java.lang.Object[] mArguments
The arguments to this exception's message, if any. This allows anInternationalizedException
to have a compound message, made up of multiple parts that are concatenated in a language-neutral way.
-
mCause
private java.lang.Throwable mCause
The exception that caused this exception to occur.
-
-
Constructor Detail
-
UIMAException
public UIMAException()
Creates a new exception with a null message.
-
UIMAException
public UIMAException(java.lang.Throwable aCause)
Creates a new exception with the specified cause and a null message.- Parameters:
aCause
- the original exception that caused this exception to be thrown, if any
-
UIMAException
public UIMAException(java.lang.String aResourceBundleName, java.lang.String aMessageKey, java.lang.Object... aArguments)
Creates a new exception with a the specified message.- Parameters:
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 theMessageFormat
class.aArguments
- The arguments to the message.null
may be used if the message has no arguments.
-
UIMAException
public UIMAException(java.lang.String aResourceBundleName, java.lang.String aMessageKey, java.lang.Object[] aArguments, java.lang.Throwable aCause)
Creates a new exception with the specified message and cause.- Parameters:
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 theMessageFormat
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 any
-
UIMAException
public UIMAException(java.lang.String aMessageKey, java.lang.Object[] aArguments)
Creates a new exception with a message from theSTANDARD_MESSAGE_CATALOG
.- Parameters:
aMessageKey
- an identifier that maps to the message for this exception. The message may contain placeholders for arguments as defined by theMessageFormat
class.aArguments
- The arguments to the message.null
may be used if the message has no arguments.
-
UIMAException
public UIMAException(java.lang.String aMessageKey, java.lang.Object[] aArguments, java.lang.Throwable aCause)
Creates a new exception with the specified cause and a message from theSTANDARD_MESSAGE_CATALOG
.- Parameters:
aMessageKey
- an identifier that maps to the message for this exception. The message may contain placeholders for arguments as defined by theMessageFormat
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 any
-
-
Method Detail
-
getCause
public java.lang.Throwable getCause()
Gets the cause of this Exception.- Specified by:
getCause
in interfaceI18nExceptionI
- Overrides:
getCause
in classjava.lang.Throwable
- Returns:
- the Throwable that caused this Exception to occur, if any. Returns
null
if there is no such cause.
-
initCause
public java.lang.Throwable initCause(java.lang.Throwable cause)
- Overrides:
initCause
in classjava.lang.Throwable
-
getResourceBundleName
public java.lang.String getResourceBundleName()
Gets the base name of the resource bundle in which the message for this exception is located.- Specified by:
getResourceBundleName
in interfaceI18nExceptionI
- Returns:
- the resource bundle base name. May return
null
if this exception has no message.
-
getMessageKey
public java.lang.String getMessageKey()
Gets the identifier for this exception's message. This identifier can be looked up in this exception'sResourceBundle
to get the locale-specific message for this exception.- Specified by:
getMessageKey
in interfaceI18nExceptionI
- Returns:
- the resource identifier for this exception's message. May return
null
if this exception has no message.
-
getArguments
public java.lang.Object[] getArguments()
Gets the arguments to this exception's message. Arguments allow aInternationalizedException
to have a compound message, made up of multiple parts that are concatenated in a language-neutral way.- Specified by:
getArguments
in interfaceI18nExceptionI
- Returns:
- the arguments to this exception's message.
-
getMessage
public java.lang.String getMessage()
Description copied from interface:I18nExceptionI
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.- Specified by:
getMessage
in interfaceI18nExceptionI
- Overrides:
getMessage
in classjava.lang.Throwable
- Returns:
- The message of the exception. Useful for including the text in another exception.
-
getLocalizedMessage
public java.lang.String getLocalizedMessage()
Gets the localized detail message for this exception. This uses the default Locale for this JVM. A Locale may be specified usingI18nExceptionI.getLocalizedMessage(Locale)
.- Specified by:
getLocalizedMessage
in interfaceI18nExceptionI
- Overrides:
getLocalizedMessage
in classjava.lang.Throwable
- Returns:
- this exception's detail message, localized for the default Locale.
-
-