Oracle Application Server TopLink API Reference
10g Release 2 (10.1.2)

B15903-01


oracle.toplink.exceptions
Class TopLinkException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byjava.lang.RuntimeException
              extended byoracle.toplink.exceptions.TopLinkException

All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
BuilderException, CacheSynchCommunicationException, CacheSynchronizationException, CommunicationException, ConcurrencyException, ConversionException, DatabaseException, DeploymentException, EJBJarXMLException, EJBQLException, JDOException, JMSProcessingException, OptimisticLockException, RemoteCommandManagerException, SessionLoaderException, SynchronizationException, ValidationException, XMLConversionException

public abstract class TopLinkException
extends java.lang.RuntimeException

Purpose: Any exception raised by TopLink should be a subclass of this exception class.

See Also:
Serialized Form

Method Summary
int getErrorCode()
PUBLIC: Return the exception error code.
java.lang.Throwable getInternalException()
PUBLIC: Return the internal native exception.
java.lang.String getMessage()
PUBLIC: Return the exception error message.
oracle.toplink.publicinterface.Session getSession()
PUBLIC: Return the session
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.
static void setShouldPrintInternalException(boolean printException)
PUBLIC: Allows overiding of TopLink's exception chaining detection.

Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, setStackTrace

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getErrorCode

public int getErrorCode()
PUBLIC: Return the exception error code.

getInternalException

public java.lang.Throwable getInternalException()
PUBLIC: Return the internal native exception. TopLink frequently catches Java exceptions and wraps them in its own exception classes to provide more information. The internal exception can still be accessed if required.

getMessage

public java.lang.String getMessage()
PUBLIC: Return the exception error message. TopLink error messages are multi-line so that detail descriptions of the exception are given.

getSession

public oracle.toplink.publicinterface.Session getSession()
PUBLIC: Return the session

printStackTrace

public void printStackTrace()
PUBLIC: Print both the normal and internal stack traces.

printStackTrace

public void printStackTrace(java.io.PrintStream outStream)
PUBLIC: Print both the normal and internal stack traces.

printStackTrace

public void printStackTrace(java.io.PrintWriter writer)
PUBLIC: Print both the normal and internal stack traces.

setShouldPrintInternalException

public static void setShouldPrintInternalException(boolean printException)
PUBLIC: Allows overiding of TopLink's exception chaining detection.

Copyright © 1998, 2005 Oracle Corporation. All Rights Reserved.