javax.xml.xquery.XQCancelledException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xqjri Show documentation
XQuery for Java Reference Implementation
The newest version!
/*
 * Copyright © 2003, 2004, 2005, 2006, 2007, 2008 Oracle.  All rights reserved.
 */

package javax.xml.xquery;

import javax.xml.namespace.QName;

/**
 * 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.
 */
public class XQCancelledException extends XQQueryException {

 /**
   * Constructs an XQCancelledException object with a given message,
   * vendor code, error code, line number, column number, position, module URI,
   * error object, and stack trace.
   *
   * @param message        the description of the error. null indicates
   *                       that the message string is non existant
   * @param vendorCode     a vendor-specific string identifying the error.
   *                       null indicates there is no vendor
   *                       code or it is unknown
   * @param 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
   * @param line           the line number in the query string where the error occured.
   *                       Line numbering starts at 1. -1 if unknown
   * @param column         the column number in the query string where the error occured.
   *                       Column numbering starts at 1. -1 if unknown
   * @param position       the position in the query string where the error occured. This
   *                       is a 0 based position. -1 if unknown
   * @param 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
   * @param 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
   * @param stackTrace     the XQuery stack trace where the error occurred. null
   *                       if not available
   */
  public XQCancelledException(String message, String vendorCode, QName errorCode,
                          int line, int column, int position,
                          String moduleURI, XQSequence errorObject, XQStackTraceElement[] stackTrace)
  {
    super(message, vendorCode, errorCode, line, column, position, moduleURI, errorObject, stackTrace);
  }
}