com.ibm.bpe.api
Class ProcessError

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byjava.lang.RuntimeException
              extended bycom.ibm.bpe.api.ProcessError
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
EngineCompensationSphereNotCompletedError, EngineCompensationSphereStateUnknownError, EngineLookupProcessBeanError, EngineRollbackOnlyError, EngineStateObserverEventError

public class ProcessError
extends java.lang.RuntimeException

This is the base class for all runtime exceptions. Exceptions can include nested exceptions.

See Also:
Serialized Form

Constructor Summary
ProcessError(java.lang.String message)
          Constructs an error object from the error message passed.
ProcessError(java.lang.String key, java.lang.Object[] vars)
          Constructs an error object with the specified message key and remembers the values of the message variables passed.
ProcessError(java.lang.String key, java.lang.Object[] vars, java.lang.Throwable cause)
          Constructs an error object with the specified message key and exception and remembers the values of the message variables passed.
ProcessError(java.lang.String message, java.lang.Throwable cause)
          Constructs an error object from the error message and exception passed.
ProcessError(java.lang.Throwable cause)
          Constructs an error object from the exception passed.
 
Method Summary
 java.lang.Throwable getCause()
          Returns the nested exception.
 java.lang.String getMessage()
          Returns the message text of the error object.
 java.lang.String getMessage(java.util.Locale locale)
          Returns the message text of the error object.
 java.lang.String getMessageKey()
          Returns the message key.
 java.lang.Object[] getMessageVariables()
          Returns the values of message variables.
 java.lang.Throwable getRootCause()
          Returns the root exception of this error.
 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

ProcessError

public ProcessError(java.lang.String message)
Constructs an error object from the error message passed.

Parameters:
message - The error message.

ProcessError

public ProcessError(java.lang.Throwable cause)
Constructs an error object from the exception passed.

Parameters:
cause - The exception that was thrown.

ProcessError

public ProcessError(java.lang.String message,
                    java.lang.Throwable cause)
Constructs an error object from the error message and exception passed.

Parameters:
message - The error message.
cause - The exception that was thrown.

ProcessError

public ProcessError(java.lang.String key,
                    java.lang.Object[] vars)
Constructs an error 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.

ProcessError

public ProcessError(java.lang.String key,
                    java.lang.Object[] vars,
                    java.lang.Throwable cause)
Constructs an error 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 error object. If the error object contains a message key, the message text is returned in the default language.

Returns:
The message text.

getMessage

public final java.lang.String getMessage(java.util.Locale locale)
Returns the message text of the error object. If the error 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 error object does not contain a message key.
Returns:
The message text.

getMessageKey

public final java.lang.String getMessageKey()
Returns the message key.

Returns:
The message key. null is returned if a message key is not specified.

getMessageVariables

public final java.lang.Object[] getMessageVariables()
Returns the values of message variables.

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

Returns:
The nested exception. null is returned if there is no nested exception.

getRootCause

public final java.lang.Throwable getRootCause()
Returns the root exception of this error.

Returns:
The root exception.

printStackTrace

public final void printStackTrace()
Prints this exception to the standard error stream. This call is forwarded to printStackTrace(PrintWriter).


printStackTrace

public final void printStackTrace(java.io.PrintStream s)
Prints this exception to the specified print stream. This call is forwarded to printStackTrace(PrintWriter).

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.

Parameters:
s - The print writer to write to.