com.sun.jdo.api.persistence.support
Class JDOException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              com.sun.jdo.api.persistence.support.JDOException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

JDOCanRetryException, JDOFatalException

public class JDOException
extends java.lang.RuntimeException

This is the root of all JDO Exceptions. It contains an optional nested Exception and an optional message.

Version:

0.1

Author:

Craig Russell

See Also:

Serialized Form

Constructor Summary

JDOException()
Creates a new JDOException without detail message.

JDOException(java.lang.String msg)
Constructs a new JDOException with the specified detail message.

JDOException(java.lang.String msg, java.lang.Exception nested)
Constructs a new JDOException with the specified detail message and nested Exception.

JDOException(java.lang.String msg, java.lang.Exception nested, java.lang.Object[] failed)
Constructs a new JDOException with the specified detail message, nested exception, and failed object array.

JDOException(java.lang.String msg, java.lang.Object[] failed)
Constructs a new JDOException with the specified detail message and failed object array.

Method Summary

void	addFailedObject(java.lang.Object o) The exception may need to add objects to an array of failed objects.
java.lang.Object[]	getFailedObjectArray() The exception may include an array of failed objects.
java.lang.Exception	getNestedException() The exception may have been caused by an Exception in the runtime.
void	printStackTrace() Prints this JDOException and its backtrace to the standard error output.
void	printStackTrace(java.io.PrintStream s) Prints this JDOException and its backtrace to the specified print stream.
void	printStackTrace(java.io.PrintWriter s) Prints this JDOException and its backtrace to the specified print writer.
java.lang.String	toString() The String representation includes the name of the class, the descriptive comment (if any), the String representation of the nested Exception (if any), and the String representation of the failed Object array (if any).

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JDOException

public JDOException()

Creates a new JDOException without detail message.

JDOException

public JDOException(java.lang.String msg)

Constructs a new JDOException with the specified detail message.

Parameters:

msg - the detail message.

JDOException

public JDOException(java.lang.String msg,
                    java.lang.Exception nested)

Constructs a new JDOException with the specified detail message and nested Exception.

Parameters:

msg - the detail message.

nested - the nested Exception.

JDOException

public JDOException(java.lang.String msg,
                    java.lang.Object[] failed)

Constructs a new JDOException with the specified detail message and failed object array.

Parameters:

msg - the detail message.

failed - the failed object array.

JDOException

public JDOException(java.lang.String msg,
                    java.lang.Exception nested,
                    java.lang.Object[] failed)

Constructs a new JDOException with the specified detail message, nested exception, and failed object array.

Parameters:

msg - the detail message.

nested - the nested Exception.

failed - the failed object array.

Method Detail

addFailedObject

public void addFailedObject(java.lang.Object o)

The exception may need to add objects to an array of failed objects.

Parameters:

o - the failed object to add to an array.

getFailedObjectArray

public java.lang.Object[] getFailedObjectArray()

The exception may include an array of failed objects.

Returns:

the failed object array.

getNestedException

public java.lang.Exception getNestedException()

The exception may have been caused by an Exception in the runtime.

Returns:

the nested Exception.

toString

public java.lang.String toString()

The String representation includes the name of the class, the descriptive comment (if any), the String representation of the nested Exception (if any), and the String representation of the failed Object array (if any).

Overrides:

toString in class java.lang.Throwable

Returns:

the String.

printStackTrace

public void printStackTrace()

Prints this JDOException and its backtrace to the standard error output. Prints nested Throwables' stack trace as well.

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream s)

Prints this JDOException and its backtrace to the specified print stream. Prints nested Throwable's stack trace as well.

Overrides:

printStackTrace in class java.lang.Throwable

Parameters:

s - PrintStream to use for output

printStackTrace

public void printStackTrace(java.io.PrintWriter s)

Prints this JDOException and its backtrace to the specified print writer. Prints nested Throwable's stack trace as well.

Overrides:

printStackTrace in class java.lang.Throwable

Parameters:

s - PrintWriter to use for output