Package org.apache.uima

Interface I18nExceptionI

All Known Implementing Classes:
AnalysisEngineProcessException, AnnotatorConfigurationException, AnnotatorContextException, AnnotatorInitializationException, AnnotatorProcessException, CASAdminException, CASException, CASRuntimeException, CollectionException, IndexingException, InvalidXMLException, LowLevelException, ResourceAccessException, ResourceConfigurationException, ResourceInitializationException, ResourceProcessException, ResourceServiceException, ResultNotSupportedException, UIMA_IllegalArgumentException, UIMA_IllegalStateException, UIMA_UnsupportedOperationException, UIMAException, UIMARuntimeException
public interface I18nExceptionI
Like InternationalizedException, but is an interface with default methods.

This common set of default implementations are intended to be added to sets of messages collected into exception classes, which implement this, and separately extend one of the 3 superclasses:

  • Exception (for checked exceptions)
  • RuntimeException (for unchecked exceptions)
  • SaxException (for exceptions within XML parsing code

  • Method Details

    • getResourceBundleName

      String getResourceBundleName()

    • getMessageKey

      String getMessageKey()

    • getArguments

      Object[] getArguments()

    • getCause

      Throwable getCause()

    • getMessage

      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.
      Returns:
      -

    • getLocalizedMessage

      String getLocalizedMessage()

    • getLocalizedMessage

      default String getLocalizedMessage(Locale aLocale)
      Gets the localized detail message for this exception using the specified Locale.
      Parameters:
      aLocale - the locale to use for localizing the message
      Returns:
      this exception's detail message, localized for the specified Locale.

    • hasMessageKey

      default boolean hasMessageKey(String messageKey)
      Checks if this exception, or any of its root causes, has a particular UIMA message key. This allows checking for particular error condition in test cases
      Parameters:
      messageKey - to search for in the exception chain
      Returns:
      true if this exception or any of its root causes has a particular UIMA message key.