Package org.apache.uima
Class UIMAException
java.lang.Object
java.lang.Throwable
java.lang.Exception
org.apache.uima.UIMAException
- All Implemented Interfaces:
Serializable,I18nExceptionI
- Direct Known Subclasses:
AnnotatorConfigurationException,AnnotatorContextException,AnnotatorInitializationException,AnnotatorProcessException,CASException,CollectionException,IndexingException,InvalidXMLException,ResourceAccessException,ResourceConfigurationException,ResourceInitializationException,ResourceProcessException,ResourceServiceException,ResultNotSupportedException
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 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.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe name of theResourceBundlecontaining the standard UIMA Exception messages. -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new exception with a null message.UIMAException(String aMessageKey, Object[] aArguments) Creates a new exception with a message from theSTANDARD_MESSAGE_CATALOG.UIMAException(String aMessageKey, Object[] aArguments, Throwable aCause) Creates a new exception with the specified cause and a message from theSTANDARD_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. -
Method Summary
Modifier and TypeMethodDescriptionObject[]Gets the arguments to this exception's message.getCause()Gets the cause of this Exception.Gets the localized detail message for this exception.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.Gets the identifier for this exception's message.Gets the base name of the resource bundle in which the message for this exception is located.Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.uima.I18nExceptionI
getLocalizedMessage, hasMessageKey
-
Field Details
-
STANDARD_MESSAGE_CATALOG
The name of theResourceBundlecontaining the standard UIMA Exception messages.- See Also:
-
-
Constructor Details
-
UIMAException
public UIMAException()Creates a new exception with a null message. -
UIMAException
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
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 theMessageFormatclass.aArguments- The arguments to the message.nullmay be used if the message has no arguments.
-
UIMAException
public UIMAException(String aResourceBundleName, String aMessageKey, Object[] aArguments, 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 theMessageFormatclass.aArguments- The arguments to the message.nullmay be used if the message has no arguments.aCause- the original exception that caused this exception to be thrown, if any
-
UIMAException
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 theMessageFormatclass.aArguments- The arguments to the message.nullmay be used if the message has no arguments.
-
UIMAException
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 theMessageFormatclass.aArguments- The arguments to the message.nullmay be used if the message has no arguments.aCause- the original exception that caused this exception to be thrown, if any
-
-
Method Details
-
getCause
Gets the cause of this Exception.- Specified by:
getCausein interfaceI18nExceptionI- Overrides:
getCausein classThrowable- Returns:
- the Throwable that caused this Exception to occur, if any. Returns
nullif there is no such cause.
-
initCause
-
getResourceBundleName
Gets the base name of the resource bundle in which the message for this exception is located.- Specified by:
getResourceBundleNamein interfaceI18nExceptionI- Returns:
- the resource bundle base name. May return
nullif this exception has no message.
-
getMessageKey
Gets the identifier for this exception's message. This identifier can be looked up in this exception'sResourceBundleto get the locale-specific message for this exception.- Specified by:
getMessageKeyin interfaceI18nExceptionI- Returns:
- the resource identifier for this exception's message. May return
nullif this exception has no message.
-
getArguments
Gets the arguments to this exception's message. Arguments allow aInternationalizedExceptionto have a compound message, made up of multiple parts that are concatenated in a language-neutral way.- Specified by:
getArgumentsin interfaceI18nExceptionI- Returns:
- the arguments to this exception's message.
-
getMessage
Description copied from interface:I18nExceptionIDue 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:
getMessagein interfaceI18nExceptionI- Overrides:
getMessagein classThrowable- Returns:
- The message of the exception. Useful for including the text in another exception.
-
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:
getLocalizedMessagein interfaceI18nExceptionI- Overrides:
getLocalizedMessagein classThrowable- Returns:
- this exception's detail message, localized for the default Locale.
-