XQJ v1.0, Jan 14, 2008

javax.xml.xquery
Class XQCancelledException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by javax.xml.xquery.XQException
              extended by javax.xml.xquery.XQQueryException
                  extended by javax.xml.xquery.XQCancelledException
All Implemented Interfaces:
java.io.Serializable

public class XQCancelledException
extends XQQueryException

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:
Serialized Form

Constructor Summary
XQCancelledException(java.lang.String message, java.lang.String vendorCode, javax.xml.namespace.QName errorCode, int line, int column, int position, java.lang.String moduleURI, XQSequence errorObject, XQStackTraceElement[] stackTrace)
          Constructs an XQCancelledException 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
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, 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

XQCancelledException

public XQCancelledException(java.lang.String message,
                            java.lang.String vendorCode,
                            javax.xml.namespace.QName errorCode,
                            int line,
                            int column,
                            int position,
                            java.lang.String moduleURI,
                            XQSequence errorObject,
                            XQStackTraceElement[] stackTrace)
Constructs an XQCancelledException 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 existant
vendorCode - a vendor-specific string identifying the error. null indicates there is no vendor code or it is unknown
errorCode - 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 raised
line - the line number in the query string where the error occured. Line numbering starts at 1. -1 if unknown
column - the column number in the query string where the error occured. Column numbering starts at 1. -1 if unknown
position - the position in the query string where the error occured. This is a 0 based position. -1 if unknown
moduleURI - the module URI of the module in which the error occurred. null when it is the main module or when the module is unknown
errorObject - an XQSequence representing the error object passed to fn:error(). null if this error was not triggered by fn:error() or when the error object is not available
stackTrace - the XQuery stack trace where the error occurred. null if not available

XQJ v1.0, Jan 14, 2008

Copyright (c) 2003, 2006, 2007, 2008 Oracle. All rights reserved.