oracle.javatools.db

Class CancelledException

java.lang.Object

java.lang.Throwable

java.lang.Exception

oracle.javatools.db.DBException

oracle.javatools.db.CancelledException

All Implemented Interfaces:

java.io.Serializable

public class CancelledException
extends DBException

This exception is thrown if a process is cancelled mid-execution by an action of the user or api. Examples of a valid cancel could be the cancellation of a running statement against the database, or a user cancel of a long running search.

When catching CancelledException in the api, if the cancel happened on the current Thread you might want to check the interrupt status of the current Thread before continuing. Interrupt of the current Thread should not be assumed when catching this exception, as part the operation - e.g. statement execution - might have been threaded in a progress bar, and it was that Thread which was interrupted. In this example the calling Thread wouldn't also be interrupted, but this exception is used to notify the caller of the overall operation that something was cancelled.

Since:

11

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CancelledException() Creates a new cancelled exception with a generic message.
CancelledException(java.lang.String reason) Creates a new cancelled exception with a specific message.

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkInterrupt() Checks whether the current Thread has been interrupted.

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

CancelledException

public CancelledException()

Creates a new cancelled exception with a generic message.

CancelledException

public CancelledException(java.lang.String reason)

Creates a new cancelled exception with a specific message.

Parameters:

reason - the reason for the cancellation

Since:

12.1.3

Method Detail

checkInterrupt

public static void checkInterrupt()
                           throws CancelledException

Checks whether the current Thread has been interrupted. If it has a CancelledException is thrown. The Thread's interrupt flag will not be cleared because calling code is not guaranteed to be Thread aware (i.e. CancelledException is not InterruptedException).

Throws:

CancelledException - if the current Thread has been interrupted.