|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
com.ibm.task.api.TaskException
This is the base class for all exceptions thrown by the Human Task Manager.
Note that it is best practice to catch all Human Task Manager exceptions with a final catch(TaskException) statement. This statement helps to ensure the upward compatibility of your application program because it takes account of all future exceptions that can occur.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Constructor Summary | |
---|---|
TaskException(java.lang.String message)
Constructs an exception object from the error message passed. |
|
TaskException(java.lang.String key,
java.lang.Object[] vars)
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.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 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 | |
---|---|
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 |
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 |
Field Detail |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public TaskException(java.lang.String message)
message
- The error message.public TaskException(java.lang.Throwable cause)
cause
- The exception that was thrown.public TaskException(java.lang.String message, java.lang.Throwable cause)
message
- The error message.cause
- The exception that was thrown.public TaskException(java.lang.String key, java.lang.Object[] vars)
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.public TaskException(java.lang.String key, java.lang.Object[] vars, java.lang.Throwable cause)
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 |
public final java.lang.String getMessage()
public final java.lang.String getMessage(java.util.Locale locale)
locale
- The locale of the message catalog to be used. Is ignored if the exception object
does not contain a message key.
public final java.lang.String getMessageKey()
public final java.lang.Object[] getMessageVariables()
public final java.lang.Throwable getCause()
public final java.lang.Throwable getRootCause()
public final void printStackTrace()
printStackTrace(PrintWriter)
.
public final void printStackTrace(java.io.PrintStream s)
printStackTrace(PrintWriter)
.
s
- The print stream to write to.public final void printStackTrace(java.io.PrintWriter s)
s
- The print writer to write to.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |