Package javax.xml.xquery
Class XQQueryException
java.lang.Object
java.lang.Throwable
java.lang.Exception
javax.xml.xquery.XQException
javax.xml.xquery.XQQueryException
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
XQCancelledException
An exception that provides information on errors occurring during the
evaluation of an xquery.
Each XQQueryException
provides several kinds of optional
information, in addition to the properties inherited from
XQException
:
- an error code. This
QName
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 and its associated specifications; implementation-defined errors may be raised. - a position. This identifies the character position of the failing expression in
the query text. This is a
0
based position.-1
if unknown. - the line number in the query string where the error occured. Line numbering
starts at
1
.-1
if unknown - the column number in the query string where the error occured. Column numbering
starts at
1
.-1
if unknown - the module uri. This identifies the module in which the error
occurred,
null
when the error is located in the main module. - the XQuery error object of this exception. This is the
$error-object
argument specified through thefn:error()
function. May benull
if not specified. - the XQuery stack trace. This provides additional dynamic information where the exception occurred in the XQuery expression.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionXQQueryException
(String message) Constructs anXQQueryException
object with a given message.XQQueryException
(String message, String vendorCode, QName errorCode, int line, int column, int position) Constructs anXQQueryException
object with a given message, vendor code, error code, line number, column number, and position.XQQueryException
(String message, String vendorCode, QName errorCode, int line, int column, int position, String moduleURI, XQSequence errorObject, XQStackTraceElement[] stackTrace) Constructs anXQQueryException
object with a given message, vendor code, error code, line number, column number, position, module URI, error object, and stack trace.XQQueryException
(String message, QName errorCode) Constructs anXQQueryException
object with a given message, and error code.XQQueryException
(String message, QName errorCode, int line, int column, int position) Constructs anXQQueryException
object with a given message, error code, line number, column number, and position. -
Method Summary
Modifier and TypeMethodDescriptionint
Gets the column number in the query string where the error occurred.Gets the code identifying 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; imlementation-defined errors may also be raised; finally the error code may also be specified in the query usingfn:error()
.Gets anXQSequence
representing the error object passed tofn:error()
.int
Gets the line number in the query string where the error occurred.Gets the module URI of the module in which the error occurred.int
Gets the character position in the query string where this exception occurred.Returns the query stack stackTrace when the exception occurred, or null if none.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
-
XQQueryException
Constructs anXQQueryException
object with a given message.- Parameters:
message
- the description of the error.null
indicates that the message string is non existant
-
XQQueryException
Constructs anXQQueryException
object with a given message, and error code.- Parameters:
message
- the description of the error.null
indicates that the message string is non existanterrorCode
-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.
-
XQQueryException
Constructs anXQQueryException
object with a given message, error code, line number, column number, and position.- Parameters:
message
- the description of the error.null
indicates that the message string is non existanterrorCode
-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 unknown
-
XQQueryException
public XQQueryException(String message, String vendorCode, QName errorCode, int line, int column, int position) Constructs anXQQueryException
object with a given message, vendor code, error code, line number, column number, and position.- 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 unknown
-
XQQueryException
public XQQueryException(String message, String vendorCode, QName errorCode, int line, int column, int position, String moduleURI, XQSequence errorObject, XQStackTraceElement[] stackTrace) Constructs anXQQueryException
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 available.stackTrace
- the XQuery stack trace where the error occurred.null
if not available
-
-
Method Details
-
getErrorCode
Gets the code identifying 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; imlementation-defined errors may also be raised; finally the error code may also be specified in the query usingfn:error()
.- Returns:
- the code identifying the error, or
null
if not available
-
getErrorObject
Gets anXQSequence
representing the error object passed tofn:error()
. Returnsnull
if this error was not triggered byfn:error()
or when the error object is not available.- Returns:
- the sequence passed to
fn:error()
,null
if not available
-
getPosition
public int getPosition()Gets the character position in the query string where this exception occurred.This is a
0
based position.-1
if unknown.- Returns:
- the character position in the query string where the exception occurred
-
getQueryStackTrace
Returns the query stack stackTrace when the exception occurred, or null if none. On some implementations only the top frame may be visible.- Returns:
- the stackTrace where the exception occurred
-
getModuleURI
Gets the module URI of the module in which the error occurred.null
when it is the main module or when the module is unknown.- Returns:
- the module URI or
null
-
getLineNumber
public int getLineNumber()Gets the line number in the query string where the error occurred.Line numbering starts at
1
.-1
is returned if the line number is unknown. If the implementation does not support this method, it must return-1
- Returns:
- the line number in the query string where the error occurred
-
getColumnNumber
public int getColumnNumber()Gets the column number in the query string where the error occurred.Column numbering starts at
1
.-1
is returned if the column number is unknown. If the implementation does not support this method, it must return-1
- Returns:
- the column number in the query string where the error occurred
-