org.tmapi.core
Class TMAPIException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byorg.tmapi.core.TMAPIException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
FactoryConfigurationException, HelperObjectConfigurationException, HelperObjectInstantiationException, TMAPIIndexException, TopicInUseException, TopicMapExistsException, UnsupportedHelperObjectException

public class TMAPIException
extends java.lang.Exception

The base class for all standard (non run-time) exceptions thrown by a TMAPI system.

This class implements the JDK 1.4 method getCause() which allows TMAPI exceptions to be integrated into the JDK 1.4 exception chaining mechanism while retaining compatibility with JDK versions prior to 1.4.

See Also:
Serialized Form

Constructor Summary
TMAPIException(java.lang.String msg)
          Constructs a new throwable with the specified detail message.
TMAPIException(java.lang.String msg, java.lang.Throwable cause)
          Constructs a new exception with the specified detail message and cause.
TMAPIException(java.lang.Throwable cause)
          Constructs a new exception that wraps another exception.
 
Method Summary
 java.lang.Throwable getCause()
          Returns the cause of this exception or null if the cause is nonexistent or unknown.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TMAPIException

public TMAPIException(java.lang.String msg)
Constructs a new throwable with the specified detail message. The cause is not initialized.

Parameters:
msg - the detail message. This message is saved for later retrieval by the Throwable.getMessage() method.

TMAPIException

public TMAPIException(java.lang.Throwable cause)
Constructs a new exception that wraps another exception.

Parameters:
cause - the throwable which caused this exception to be thrown. This value is saved for later retrieval by the getCause() method.

TMAPIException

public TMAPIException(java.lang.String msg,
                      java.lang.Throwable cause)
Constructs a new exception with the specified detail message and cause.

Parameters:
msg - the detail message. This message is saved for later retrieval by the Throwable.getMessage() method
cause - the throwable which caused this exception to be thrown. This value is saved for later retrieval by the getCause() method.
Method Detail

getCause

public java.lang.Throwable getCause()
Returns the cause of this exception or null if the cause is nonexistent or unknown. (The cause is the throwable that caused this exception to get thrown.)