Package javax.xml.xquery
Class XQStackTraceElement
java.lang.Object
javax.xml.xquery.XQStackTraceElement
- All Implemented Interfaces:
Serializable
This class represents a frame in a stack trace, akin to the
java.lang.StackTraceElement
but for XQuery callstacks
instead of Java.- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionXQStackTraceElement
(String moduleURI, int line, int column, int position, QName function, XQStackTraceVariable[] variables) Construct anXQStackTraceElement
object representing a frame in a stack trace. -
Method Summary
Modifier and TypeMethodDescriptionint
Gets the column number in the query string containing the execution point represented by this stack trace element.Gets theQName
of the function in which the error occurred, ornull
if it occurred outside an enclosing function (in a main module).int
Gets the line number in the query string containing the execution point represented by this stack trace element.Gets the module URI containing the execution point represented by this stack trace element.int
Gets the character position in the query string containing the execution point represented by this stack trace element.Gets the variables in scope at this execution point, ornull
if no variable value retrieval is possible.
-
Constructor Details
-
XQStackTraceElement
public XQStackTraceElement(String moduleURI, int line, int column, int position, QName function, XQStackTraceVariable[] variables) Construct anXQStackTraceElement
object representing a frame in a stack trace.- Parameters:
moduleURI
- the module URI containing the execution point representing the stack trace element.null
when it is the main module or when the module is unknownline
- 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 unknownfunction
- theQName
of the function in which the exception occurred, ornull
if it occurred outside an enclosing functionvariables
- the variables in scope at this execution point, ornull
if no variable value retrieval is possible
-
-
Method Details
-
getModuleURI
Gets the module URI containing the execution point represented by this stack trace element.null
when it is the main module or when the module is unknown.- Returns:
- the module URI containing the excution point
represented by the stack trace element or
null
-
getPosition
public int getPosition()Gets the character position in the query string containing the execution point represented by this stack trace element.This is a
0
based position.-1
if unknown.- Returns:
- the character position in the query string containing the execution point represented by the stack trace element
-
getLineNumber
public int getLineNumber()Gets the line number in the query string containing the execution point represented by this stack trace element.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 containing the execution point represented by the stack trace element
-
getColumnNumber
public int getColumnNumber()Gets the column number in the query string containing the execution point represented by this stack trace element.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 containing the execution point represented by the stack trace element
-
getFunctionQName
Gets theQName
of the function in which the error occurred, ornull
if it occurred outside an enclosing function (in a main module).- Returns:
- the
QName
of the function in which the error occurred for this stack element ornull
if it occurred outside an enclosing function
-
getVariables
Gets the variables in scope at this execution point, ornull
if no variable value retrieval is possible.- Returns:
- the variables in scope at this execution point, or
null
if no variable value retrieval is possible.
-