oracle.javatools.db.sql

Class SQLQueryCancelledException

java.lang.Object

java.lang.Throwable

java.lang.Exception

oracle.javatools.db.DBException

oracle.javatools.db.sql.SQLQueryException

oracle.javatools.db.sql.SQLQueryCancelledException

All Implemented Interfaces:

java.io.Serializable

public class SQLQueryCancelledException
extends SQLQueryException

SQLQueryException thrown when the build of a SQLQuery is interrupted or cancelled by the user.

This exception might be thrown because a query build has been explictly cancelled, or because the current Thread has been interrupted. When catching, the Thread's interrupt flag will indicate if it was the latter (and the calling code can behave accordingly if it is Thread aware).

This is separate to CancelledException because it needs to fit within the SQLQueryBuilder framework and its use of SQLQueryException (rather than DBException). When a SQLQueryBuilder exposes a throws to any generic db api code (e.g. property building) it can translate it in to a CancelledException. Clients of SQLQueryBuilder itself can deal with SQLQueryCancelledException, but only need do so specifically if they make the building cancellable (e.g. in a progress bar).

Since:

12.1.3

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SQLQueryCancelledException(SQLQuery query) Constructs a new exception to indicate that the declarative build of the given query has been cancelled.

Method Summary

Methods inherited from class oracle.javatools.db.DBException

append, getAllMessages, getMessage, getNextException, getObject, getRelatedObjects, setNextException, setRelatedObjects

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

SQLQueryCancelledException

public SQLQueryCancelledException(SQLQuery query)

Constructs a new exception to indicate that the declarative build of the given query has been cancelled.

Parameters:

query - the query object that is not built because it was cancelled.