Package org.apache.uima.internal.util

Class UtilError

  • All Implemented Interfaces:
    java.io.Serializable
    public class UtilError
extends java.lang.RuntimeException
    Exception class for package org.apache.uima.util. Automatically generated from message catalog.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ILLEGAL_DTR_INDEX
      Out of bounds error while retrieving daughter node.
      static int ILLEGAL_PREDECESSOR_INDEX
      Index out of bounds error while retrieving predecessor node.
      static int ILLEGAL_SUCCESSOR_INDEX
      Index out of bounds error while retrieving successor node.

    • Constructor Summary

      Constructors 
      Constructor Description
      UtilError​(int error)
      Create a new UtilError

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean addArgument​(java.lang.String s)
      Add an argument to a UtilError object.
      int getError()  
      java.lang.String getMessage()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • ILLEGAL_DTR_INDEX

        public static final int ILLEGAL_DTR_INDEX
        Out of bounds error while retrieving daughter node.
        See Also:
        Constant Field Values

      • ILLEGAL_SUCCESSOR_INDEX

        public static final int ILLEGAL_SUCCESSOR_INDEX
        Index out of bounds error while retrieving successor node.
        See Also:
        Constant Field Values

      • ILLEGAL_PREDECESSOR_INDEX

        public static final int ILLEGAL_PREDECESSOR_INDEX
        Index out of bounds error while retrieving predecessor node.
        See Also:
        Constant Field Values

    • Constructor Detail

      • UtilError

        public UtilError​(int error)
        Create a new UtilError
        Parameters:
        error - The error code.

    • Method Detail

      • getError

        public int getError()
        Returns:
        The error code for the exception. This may be useful when the error needs to be handed over language boundaries. Instead of handing over the complete exception object, return the error code, and the receiving application can look up the error in the message file. Unfortunately, the error parameters get lost that way.

      • getMessage

        public java.lang.String getMessage()
        Overrides:
        getMessage in class java.lang.Throwable
        Returns:
        The message of the exception. Useful for including the text in another exception.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Throwable
        Returns:
        The same as getMessage(), but prefixed with "UtilError: ".

      • addArgument

        public boolean addArgument​(java.lang.String s)
        Add an argument to a UtilError object. Excess arguments will be ignored, and missing arguments will have the value null. Add arguments in the order in which they are specified in the message catalog (i.e. add %1 first, %2 next, and so on). Adding a null String has no effect! So if you don't know the value of an argument, use something like "" or "UNKNOWN", but not null.
        Parameters:
        s - -
        Returns:
        -