Package javax.xml.xquery
Class XQCancelledException
java.lang.Object
java.lang.Throwable
java.lang.Exception
javax.xml.xquery.XQException
javax.xml.xquery.XQQueryException
javax.xml.xquery.XQCancelledException
- All Implemented Interfaces:
Serializable
XQCancelledException
is an exception to indicate that the
current XQuery processing is cancelled by the application through a
cancel()
request. This exception allows an application to
easily differentiate between a user's cancellation of the query from a
general execution failure.- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionXQCancelledException
(String message, String vendorCode, QName errorCode, int line, int column, int position, String moduleURI, XQSequence errorObject, XQStackTraceElement[] stackTrace) Constructs anXQCancelledException
object with a given message, vendor code, error code, line number, column number, position, module URI, error object, and stack trace. -
Method Summary
Methods inherited from class javax.xml.xquery.XQQueryException
getColumnNumber, getErrorCode, getErrorObject, getLineNumber, getModuleURI, getPosition, getQueryStackTrace
Methods inherited from class javax.xml.xquery.XQException
getNextException, getVendorCode, setNextException
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Constructor Details
-
XQCancelledException
public XQCancelledException(String message, String vendorCode, QName errorCode, int line, int column, int position, String moduleURI, XQSequence errorObject, XQStackTraceElement[] stackTrace) Constructs anXQCancelledException
object with a given message, vendor code, error code, line number, column number, position, module URI, error object, and stack trace.- Parameters:
message
- the description of the error.null
indicates that the message string is non existantvendorCode
- a vendor-specific string identifying the error.null
indicates there is no vendor code or it is unknownerrorCode
-QName
which identifies the error according to the standard as described in Appendix F, XQuery 1.0: An XML Query language, Appendix C, XQuery 1.0 and XPath 2.0 Functions and Operators, and its associated specifications; implementation-defined errors may be raisedline
- the line number in the query string where the error occured. Line numbering starts at1
.-1
if unknowncolumn
- the column number in the query string where the error occured. Column numbering starts at1
.-1
if unknownposition
- the position in the query string where the error occured. This is a0
based position.-1
if unknownmoduleURI
- the module URI of the module in which the error occurred.null
when it is the main module or when the module is unknownerrorObject
- anXQSequence
representing the error object passed tofn:error()
.null
if this error was not triggered byfn:error()
or when the error object is not availablestackTrace
- the XQuery stack trace where the error occurred.null
if not available
-