com.ibm.task.api

Class TaskException

  • java.lang.Object
    • java.lang.Throwable
      • java.lang.Exception
        • com.ibm.task.api.TaskException
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT 
    • Constructor Summary

      Constructors 
      Constructor and Description
      TaskException(java.lang.String message)
      Constructs an exception object from the error message passed.
      TaskException(java.lang.String key, java.lang.Object[] vars)
      Deprecated. 
      TaskException(java.lang.String key, java.lang.Object[] vars, java.lang.String id)
      Constructs an exception object with the specified message key and remembers the values of the message variables passed.
      TaskException(java.lang.String key, java.lang.Object[] vars, java.lang.String id, java.lang.Throwable cause)
      Constructs an exception object with the specified message key and exception and remembers the values of the message variables passed.
      TaskException(java.lang.String key, java.lang.Object[] vars, java.lang.Throwable cause)
      TaskException(java.lang.String message, java.lang.Throwable cause)
      Constructs an exception object from the error message and the exception passed.
      TaskException(java.lang.Throwable cause)
      Constructs an exception object from the exception passed.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Throwable getCause()
      Returns the nested exception.
      java.lang.String getMessage()
      Returns the message text of the exception object.
      java.lang.String getMessage(java.util.Locale locale)
      Returns the message text of the exception object in the specified language.
      java.lang.String getMessageID()
      Returns the message id
      java.lang.String getMessageKey()
      Returns the message key.
      java.lang.Object[] getMessageVariables()
      Returns the values of the message variables.
      java.lang.Throwable getRootCause()
      Returns the root exception of this exception.
      void printStackTrace()
      Prints this exception to the standard error stream.
      void printStackTrace(java.io.PrintStream s)
      Prints this exception to the specified print stream.
      void printStackTrace(java.io.PrintWriter s)
      Prints this exception to the specified print writer.
      • Methods inherited from class java.lang.Throwable

        fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • TaskException

        public TaskException(java.lang.String message)
        Constructs an exception object from the error message passed.
        Parameters:
        message - The error message.
      • TaskException

        public TaskException(java.lang.Throwable cause)
        Constructs an exception object from the exception passed.
        Parameters:
        cause - The exception that was thrown.
      • TaskException

        public TaskException(java.lang.String message,
                     java.lang.Throwable cause)
        Constructs an exception object from the error message and the exception passed.
        Parameters:
        message - The error message.
        cause - The exception that was thrown.
      • TaskException

        public TaskException(java.lang.String key,
                     java.lang.Object[] vars,
                     java.lang.String id)
        Constructs an exception object with the specified message key and remembers the values of the message variables passed. The error message can thus localize the cause of the error.
        Parameters:
        key - The message key.
        vars - The values of the message variables. Can be an empty array. If the array contains objects, they must be Serializable.
        id - The message id.
      • TaskException

        public TaskException(java.lang.String key,
                     java.lang.Object[] vars,
                     java.lang.String id,
                     java.lang.Throwable cause)
        Constructs an exception object with the specified message key and exception and remembers the values of the message variables passed. The error message can thus localize the cause of the error.
        Parameters:
        key - The message key.
        vars - The values of the message variables. Can be an empty array. If the array contains objects, they must be Serializable.
        id - The message id.
        cause - The exception that was thrown.
      • TaskException

        public TaskException(java.lang.String key,
                     java.lang.Object[] vars)
        Deprecated. Use TaskException(String, Object[], String) instead.
        Constructs an exception object with the specified message key and remembers the values of the message variables passed. The error message can thus localize the cause of the error.
        Parameters:
        key - The message key.
        vars - The values of the message variables. Can be an empty array. If the array contains objects, they must be Serializable.
      • TaskException

        public TaskException(java.lang.String key,
                     java.lang.Object[] vars,
                     java.lang.Throwable cause)
        Constructs an exception object with the specified message key and exception and remembers the values of the message variables passed. The error message can thus localize the cause of the error.
        Parameters:
        key - The message key.
        vars - The values of the message variables. Can be an empty array. If the array contains objects, they must be Serializable.
        cause - The exception that was thrown.
    • Method Detail

      • getMessage

        public final java.lang.String getMessage()
        Returns the message text of the exception object. If the exception object contains a message key, the message text is returned in the default language.
        Overrides:
        getMessage in class java.lang.Throwable
        Returns:
        String - The message text.
      • getMessage

        public final java.lang.String getMessage(java.util.Locale locale)
        Returns the message text of the exception object in the specified language. If the exception object contains a message key, the message text is returned in the specified language.
        Parameters:
        locale - The locale of the message catalog to be used. Is ignored if the exception object does not contain a message key.
        Returns:
        String - The message text.
      • getMessageKey

        public final java.lang.String getMessageKey()
        Returns the message key.
        Returns:
        String - The message key. If a message key is not specified, null is returned.
      • getMessageID

        public final java.lang.String getMessageID()
        Returns the message id
        Returns:
        String - The message id. If a message id is not specified, null is returned.
      • getMessageVariables

        public final java.lang.Object[] getMessageVariables()
        Returns the values of the message variables.
        Returns:
        Object[] - The array of variable values. An empty array is returned if there are no variable values.
      • getCause

        public final java.lang.Throwable getCause()
        Returns the nested exception.
        Overrides:
        getCause in class java.lang.Throwable
        Returns:
        Throwable - The nested exception. If there is no nested exception, null is returned.
      • getRootCause

        public final java.lang.Throwable getRootCause()
        Returns the root exception of this exception.
        Returns:
        Throwable - The root exception.
      • printStackTrace

        public final void printStackTrace()
        Prints this exception to the standard error stream. This call is forwarded to printStackTrace(PrintWriter).
        Overrides:
        printStackTrace in class java.lang.Throwable
      • printStackTrace

        public final void printStackTrace(java.io.PrintStream s)
        Prints this exception to the specified print stream. This call will be forwarded to printStackTrace(PrintWriter).
        Overrides:
        printStackTrace in class java.lang.Throwable
        Parameters:
        s - The print stream to write to.
      • printStackTrace

        public final void printStackTrace(java.io.PrintWriter s)
        Prints this exception to the specified print writer. If this exception has nested exceptions, the root exception's stack trace is printed.
        Overrides:
        printStackTrace in class java.lang.Throwable
        Parameters:
        s - The print writer to write to.
IBM Business Process ManagerTM
Release 8