oracle.javatools.db

Class DBException

java.lang.Object

java.lang.Throwable

java.lang.Exception

oracle.javatools.db.DBException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CancelledException, CascadeManager.NoCascadeRequiredException, CascadeRequiredException, DBSQLException, DependentProviderUpdateException, MissingPropertyException, MissingProviderException, SQLQueryException, ValidationException

public class DBException
extends java.lang.Exception

An Exception that is thrown by a DB model operation. DBExceptions can wrap another exception. For example, operations against a JDBC Database may result in a SQLException; this SQLException can be wrapped in a DBException for reporting back to callers.

DBExceptions can be chained so that operations such as validation, or the creation of multiple objects can result in numberous errors reported.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DBException() Allows subclasses to deal with objects/messages as appropriate.
	DBException(DBObject obj, java.lang.String msg) Constructs a new DBException on the specified object with the specified message.
	DBException(DBObject obj, java.lang.String msg, java.lang.Throwable cause) Constructs a new DBException on the specified object with the specified message and wrapping the specified throwable
	DBException(DBObject obj, java.lang.Throwable cause) Constructs a new DBException on the specified object wrapping the specified throwable
	DBException(java.lang.Throwable cause) Constructs a new DBException wrapping a throwable, without an object.

Method Summary

Modifier and Type	Method and Description
static <T extends DBException> T	append(T dbe1, T dbe2) Appends one exception to the other.
java.lang.String	getAllMessages() Gets all the messages that are associated with this exception, i.e.
java.lang.String	getMessage() Gets the message for this exception.
DBException	getNextException() Retrieves the exception chained to this DBException object.
DBObject	getObject() The object on which this exception occurred.
DBObject[]	getRelatedObjects() Gets any other objects that are related to this DBException.
void	setNextException(DBException ex) Adds an DBException object to the end of the chain.
void	setRelatedObjects(DBObject... objs) Sets the objects that are related to this exception - i.e.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, 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

DBException

public DBException(DBObject obj,
                   java.lang.String msg)

Constructs a new DBException on the specified object with the specified message.

Parameters:

obj - the object on which the exception occurred.

msg - the message describing the exception.

DBException

public DBException(DBObject obj,
                   java.lang.String msg,
                   java.lang.Throwable cause)

Constructs a new DBException on the specified object with the specified message and wrapping the specified throwable

Parameters:

obj - the object on which the exception occurred.

msg - the message describing the exception.

cause - the root cause of the exception

DBException

public DBException(DBObject obj,
                   java.lang.Throwable cause)

Constructs a new DBException on the specified object wrapping the specified throwable

Parameters:

obj - the object on which the exception occurred.

cause - the root cause of the exception

DBException

public DBException(java.lang.Throwable cause)

Constructs a new DBException wrapping a throwable, without an object. This constructor can be used to report errors that are not associated with a specific object - for example, when getting a list of objects from a DBObjectProvider.

Parameters:

cause - the Throwable that represents the underlying problem.

DBException

protected DBException()

Allows subclasses to deal with objects/messages as appropriate.

Method Detail

getObject

public DBObject getObject()

The object on which this exception occurred.

Returns:

the DBObject on which this exception occurred.

getRelatedObjects

public DBObject[] getRelatedObjects()

Gets any other objects that are related to this DBException. For example with an invalid foreign key the primary object for the exception will be the foreign key, but the referenced primary key might also be recorded as a related object.

Returns:

the related objects

setRelatedObjects

public void setRelatedObjects(DBObject... objs)

Sets the objects that are related to this exception - i.e. not the invalid object itself, but other objects that cause it to be invalid.

Parameters:

objs - the related objects

getNextException

public DBException getNextException()

Retrieves the exception chained to this DBException object.

Returns:

the next DBException object in the chain; null if there are none

See Also:

setNextException(oracle.javatools.db.DBException)

setNextException

public void setNextException(DBException ex)

Adds an DBException object to the end of the chain.

Parameters:

ex - the new exception that will be added to the end of the DBException chain

See Also:

getNextException()

getMessage

public java.lang.String getMessage()

Gets the message for this exception. This does not include messages for any chained exceptions. For a complete message use getAllMessages()

Overrides:

getMessage in class java.lang.Throwable

Returns:

the message for this exception

See Also:

getAllMessages()

getAllMessages

public java.lang.String getAllMessages()

Gets all the messages that are associated with this exception, i.e. the message for this exception, and the messages for all chained exceptions as well.

Returns:

a single message from all the messages of this and any chained exceptions.

See Also:

setNextException(oracle.javatools.db.DBException)

append

public static <T extends DBException> T append(T dbe1,
                                               T dbe2)

Appends one exception to the other. If one exception is null then the non-null exception is returned. If both are null then null is returned.

Parameters:

dbe1 - the first exception

dbe2 - the second exception which will be appended to the first exception if the first exception isn't null

Returns:

an exception containing both errors assuming one isn't null

See Also:

setNextException(DBException)