public abstract class TopLinkException
extends java.lang.RuntimeException
Purpose: Any exception raised by TopLink should be a subclass of this exception class.
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
CR |
protected int |
errorCode |
protected boolean |
hasBeenLogged |
protected java.lang.String |
indentationString |
protected java.lang.Throwable |
internalException |
protected AbstractSession |
session |
protected static java.lang.Boolean |
shouldPrintInternalException |
Constructor and Description |
---|
TopLinkException()
INTERNAL:
Return a new exception.
|
TopLinkException(java.lang.String theMessage)
INTERNAL:
TopLink exception should only be thrown by TopLink.
|
TopLinkException(java.lang.String message,
java.lang.Throwable internalException)
INTERNAL:
TopLink exception should only be thrown by TopLink.
|
Modifier and Type | Method and Description |
---|---|
protected static java.lang.String |
cr()
INTERNAL:
Convenience method - return a platform-specific line-feed.
|
int |
getErrorCode()
PUBLIC:
Return the exception error code.
|
java.lang.String |
getIndentationString()
INTERNAL:
Used to print things nicely in the testing tool.
|
java.lang.Throwable |
getInternalException()
PUBLIC:
Return the internal native exception.
|
java.lang.String |
getMessage()
PUBLIC:
Return the exception error message.
|
AbstractSession |
getSession()
PUBLIC:
Return the session.
|
boolean |
hasBeenLogged()
INTERNAL:
Return if this exception has been logged to avoid being logged more than once.
|
void |
printStackTrace()
PUBLIC:
Print both the normal and internal stack traces.
|
void |
printStackTrace(java.io.PrintStream outStream)
PUBLIC:
Print both the normal and internal stack traces.
|
void |
printStackTrace(java.io.PrintWriter writer)
PUBLIC:
Print both the normal and internal stack traces.
|
void |
setErrorCode(int errorCode)
INTERNAL:
|
void |
setHasBeenLogged(boolean logged)
INTERNAL:
Set this flag to avoid logging an exception more than once.
|
void |
setIndentationString(java.lang.String indentationString)
INTERNAL:
Used to print things nicely in the testing tool.
|
void |
setInternalException(java.lang.Throwable anException)
INTERNAL:
Used to specify the internal exception.
|
void |
setSession(AbstractSession session)
INTERNAL:
|
static void |
setShouldPrintInternalException(boolean printException)
PUBLIC:
Allows overiding of TopLink's exception chaining detection.
|
static boolean |
shouldPrintInternalException()
INTERNAL
Check to see if the TopLink-stored internal exception should be printed in this
a TopLinkException's stack trace.
|
java.lang.String |
toString()
INTERNAL:
|
protected transient AbstractSession session
protected java.lang.Throwable internalException
protected static java.lang.Boolean shouldPrintInternalException
protected java.lang.String indentationString
protected int errorCode
protected static final java.lang.String CR
protected boolean hasBeenLogged
public TopLinkException()
public TopLinkException(java.lang.String theMessage)
public TopLinkException(java.lang.String message, java.lang.Throwable internalException)
protected static java.lang.String cr()
public int getErrorCode()
public java.lang.String getIndentationString()
public java.lang.Throwable getInternalException()
public java.lang.String getMessage()
getMessage
in class java.lang.Throwable
public AbstractSession getSession()
public boolean hasBeenLogged()
public void printStackTrace()
printStackTrace
in class java.lang.Throwable
public void printStackTrace(java.io.PrintStream outStream)
printStackTrace
in class java.lang.Throwable
public void printStackTrace(java.io.PrintWriter writer)
printStackTrace
in class java.lang.Throwable
public void setErrorCode(int errorCode)
public void setHasBeenLogged(boolean logged)
public void setIndentationString(java.lang.String indentationString)
public void setInternalException(java.lang.Throwable anException)
public void setSession(AbstractSession session)
public static void setShouldPrintInternalException(boolean printException)
booleam
- printException - If printException is true, the TopLink-stored
Internal exception will be included in a stack traceor in the exception message of a TopLinkException.
If printException is false, the TopLink-stored Internal Exception will not be included
in the stack trace or the exception message of TopLinkExceptionspublic static boolean shouldPrintInternalException()
public java.lang.String toString()
toString
in class java.lang.Throwable