public class XQQueryException extends XQException
XQQueryException
provides several kinds of optional
information, in addition to the properties inherited from
XQException
:
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.0
based position. -1
if unknown.1
. -1
if unknown1
. -1
if unknownnull
when the error is located in the main module.$error-object
argument specified through the fn:error()
function. May be null
if not specified. Constructor and Description |
---|
XQQueryException(java.lang.String message)
Constructs an
XQQueryException object with a given message. |
XQQueryException(java.lang.String message,
javax.xml.namespace.QName errorCode)
Constructs an
XQQueryException object with a given message,
and error code. |
XQQueryException(java.lang.String message,
javax.xml.namespace.QName errorCode,
int line,
int column,
int position)
Constructs an
XQQueryException object with a given message,
error code, line number, column number, and position. |
XQQueryException(java.lang.String message,
java.lang.String vendorCode,
javax.xml.namespace.QName errorCode,
int line,
int column,
int position)
Constructs an
XQQueryException object with a given message,
vendor code, error code, line number, column number, and position. |
XQQueryException(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
XQQueryException object with a given message,
vendor code, error code, line number, column number, position, module URI,
error object, and stack trace. |
Modifier and Type | Method and Description |
---|---|
int |
getColumnNumber()
Gets the column number in the query string where the error occurred.
|
javax.xml.namespace.QName |
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 using
fn:error() . |
XQSequence |
getErrorObject()
Gets an
XQSequence representing the error object passed to
fn:error() . |
int |
getLineNumber()
Gets the line number in the query string where the error occurred.
|
java.lang.String |
getModuleURI()
Gets the module URI of the module in which the error occurred.
|
int |
getPosition()
Gets the character position in the query string where this exception
occurred.
|
XQStackTraceElement[] |
getQueryStackTrace()
Returns the query stack stackTrace when the exception occurred, or null if
none.
|
getNextException, getVendorCode, setNextException
public XQQueryException(java.lang.String message)
XQQueryException
object with a given message.message
- the description of the error. null
indicates
that the message string is non existantpublic XQQueryException(java.lang.String message, javax.xml.namespace.QName errorCode)
XQQueryException
object with a given message,
and error code.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.public XQQueryException(java.lang.String message, javax.xml.namespace.QName errorCode, int line, int column, int position)
XQQueryException
object with a given message,
error code, line number, column number, and position.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 at 1
. -1
if unknowncolumn
- the column number in the query string where the error occured.
Column numbering starts at 1
. -1
if unknownposition
- the position in the query string where the error occured. This
is a 0
based position. -1
if unknownpublic XQQueryException(java.lang.String message, java.lang.String vendorCode, javax.xml.namespace.QName errorCode, int line, int column, int position)
XQQueryException
object with a given message,
vendor code, error code, line number, column number, and position.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 at 1
. -1
if unknowncolumn
- the column number in the query string where the error occured.
Column numbering starts at 1
. -1
if unknownposition
- the position in the query string where the error occured. This
is a 0
based position. -1
if unknownpublic XQQueryException(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)
XQQueryException
object with a given message,
vendor code, error code, line number, column number, position, module URI,
error object, and stack trace.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 at 1
. -1
if unknowncolumn
- the column number in the query string where the error occured.
Column numbering starts at 1
. -1
if unknownposition
- the position in the query string where the error occured. This
is a 0
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
- 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 availablepublic javax.xml.namespace.QName getErrorCode()
fn:error()
.null
if not availablepublic XQSequence getErrorObject()
XQSequence
representing the error object passed to
fn:error()
. Returns null
if this error was not triggered by
fn:error()
or when the error object is not available.fn:error()
,
null
if not availablepublic int getPosition()
0
based position. -1
if unknown.public XQStackTraceElement[] getQueryStackTrace()
public java.lang.String getModuleURI()
null
when it is the main module or when the module is
unknown.null
public int getLineNumber()
1
. -1
is returned
if the line number is unknown. If the implementation does not support this method,
it must return -1
public int getColumnNumber()
1
. -1
is returned
if the column number is unknown. If the implementation does not support this method,
it must return -1
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.