|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
com.ibm.task.api.TaskError
public class TaskError
This class is the base class for all Human Task Manager runtime exceptions. Exceptions can include nested exceptions.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Constructor Summary | |
---|---|
TaskError(java.lang.Exception parExcpt)
This constructor creates an error object using the passed exception. |
|
TaskError(java.lang.String parMessage)
This constructor creates an error object using the passed message. |
|
TaskError(java.lang.String parKey,
java.lang.Object[] parVarArr)
Deprecated. Use TaskError(String, Object[], String) instead. |
|
TaskError(java.lang.String parKey,
java.lang.Object[] parVarArr,
java.lang.String parID)
This constructor creates an error object using the passed message key and the passed message variables (as array). |
|
TaskError(java.lang.String parKey,
java.lang.Object[] parVarArr,
java.lang.String parID,
java.lang.Throwable parExcpt)
This constructor creates an error object using the passed message key, the passed message variables (as array) and the exception. |
|
TaskError(java.lang.String parKey,
java.lang.Object[] parVarArr,
java.lang.Throwable parExcpt)
Deprecated. Use TaskError(String, Object[], String, Throwable) instead. |
|
TaskError(java.lang.String parMessage,
java.lang.Throwable parExcpt)
This constructor creates an error object using the passed message and exception. |
Method Summary | |
---|---|
java.lang.Throwable |
getCause()
This method returns the nested exception. |
java.lang.String |
getMessage()
This method returns the message text stored in this instance. |
java.lang.String |
getMessage(java.util.Locale parLocale)
This method returns the message text stored in this instancet. |
java.lang.String |
getMessageID()
This method returns the message id. |
java.lang.String |
getMessageKey()
This method returns the message key. |
java.lang.Object[] |
getMessageVariables()
This method returns the values of message variables. |
java.lang.Throwable |
getRootCause()
This method returns the root exception of this error. |
void |
printStackTrace()
This method prints this exception to the standard error stream. |
void |
printStackTrace(java.io.PrintStream parPrintStream)
This method prints this exception to the specified print stream. |
void |
printStackTrace(java.io.PrintWriter parPrintWriter)
This method 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 TaskError(java.lang.String parMessage)
parMessage
- error messagepublic TaskError(java.lang.Exception parExcpt)
parExcpt
- exception that has caused the errorpublic TaskError(java.lang.String parMessage, java.lang.Throwable parExcpt)
parMessage
- error messageparExcpt
- exception that has caused the errorpublic TaskError(java.lang.String parKey, java.lang.Object[] parVarArr, java.lang.String parID)
The error message can thus localize the cause of the error.
Note: If the passed variable array contains objects, they must be serializable.
parKey
- message keyparVarArr
- message variables array (can be empty)parID
- message idpublic TaskError(java.lang.String parKey, java.lang.Object[] parVarArr, java.lang.String parID, java.lang.Throwable parExcpt)
The error message can thus localize the cause of the error.
parKey
- message keyparVarArr
- message variables array (can be empty)parID
- message idparExcpt
- exception that has caused the errorpublic TaskError(java.lang.String parKey, java.lang.Object[] parVarArr)
TaskError(String, Object[], String)
instead.
The error message can thus localize the cause of the error.
Note: If the passed variable array contains objects, they must be serializable.
parKey
- message keyparVarArr
- message variables array (can be empty)public TaskError(java.lang.String parKey, java.lang.Object[] parVarArr, java.lang.Throwable parExcpt)
TaskError(String, Object[], String, Throwable)
instead.
The error message can thus localize the cause of the error.
parKey
- message keyparVarArr
- message variables array (can be empty)parExcpt
- exception that has caused the errorMethod Detail |
---|
public final java.lang.String getMessage()
Note: The message text is returned in the default language.
getMessage
in class java.lang.Throwable
public final java.lang.String getMessage(java.util.Locale parLocale)
Note: The local 'parLocale' is ignored if the instance doesn't contain a message key.
parLocale
- locale of the message catalog to be used.
public final java.lang.String getMessageKey()
Note: If a message key is not specified null
is returned.
public final java.lang.String getMessageID()
Note: If a message id is not specified null
is returned.
public final java.lang.Object[] getMessageVariables()
Note: If there a no variable values, null
is returned.
public final java.lang.Throwable getCause()
Note: If there a no nested exception, null
is returned.
getCause
in class java.lang.Throwable
public final java.lang.Throwable getRootCause()
public final void printStackTrace()
printStackTrace(PrintWriter)
.
printStackTrace
in class java.lang.Throwable
public final void printStackTrace(java.io.PrintStream parPrintStream)
printStackTrace(PrintWriter)
.
printStackTrace
in class java.lang.Throwable
parPrintStream
- print stream to write topublic final void printStackTrace(java.io.PrintWriter parPrintWriter)
printStackTrace
in class java.lang.Throwable
parPrintWriter
- print writer to write to
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |