<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:46 GMT 2011 --> <TITLE> XQStackTraceElement </TITLE> <META NAME="date" CONTENT="2011-12-09"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="XQStackTraceElement"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../javax/xml/xquery/XQSequenceType.html" title="interface in javax.xml.xquery"><B>PREV CLASS</B></A> <A HREF="../../../javax/xml/xquery/XQStackTraceVariable.html" title="class in javax.xml.xquery"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?javax/xml/xquery/XQStackTraceElement.html" target="_top"><B>FRAMES</B></A> <A HREF="XQStackTraceElement.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> javax.xml.xquery</FONT> <BR> Class XQStackTraceElement</H2> <PRE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>javax.xml.xquery.XQStackTraceElement</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD> </DL> <HR> <DL> <DT><PRE>public class <B>XQStackTraceElement</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL> </PRE> <P> This class represents a frame in a stack trace, akin to the <code>java.lang.StackTraceElement</code> but for XQuery callstacks instead of Java. <P> <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../javax/xml/xquery/XQQueryException.html#getQueryStackTrace()"><CODE><code>XQQueryException.getQueryStackTrace</code></CODE></A>, <A HREF="../../../serialized-form.html#javax.xml.xquery.XQStackTraceElement">Serialized Form</A></DL> <HR> <P> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../javax/xml/xquery/XQStackTraceElement.html#XQStackTraceElement(java.lang.String, int, int, int, javax.xml.namespace.QName, javax.xml.xquery.XQStackTraceVariable[])">XQStackTraceElement</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> moduleURI, int line, int column, int position, <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</A> function, <A HREF="../../../javax/xml/xquery/XQStackTraceVariable.html" title="class in javax.xml.xquery">XQStackTraceVariable</A>[] variables)</CODE> <BR> Construct an <code>XQStackTraceElement</code> object representing a frame in a stack trace.</TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../javax/xml/xquery/XQStackTraceElement.html#getColumnNumber()">getColumnNumber</A></B>()</CODE> <BR> Gets the column number in the query string containing the execution point represented by this stack trace element.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../javax/xml/xquery/XQStackTraceElement.html#getFunctionQName()">getFunctionQName</A></B>()</CODE> <BR> Gets the <code>QName</code> of the function in which the error occurred, or <code>null</code> if it occurred outside an enclosing function (in a main module).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../javax/xml/xquery/XQStackTraceElement.html#getLineNumber()">getLineNumber</A></B>()</CODE> <BR> Gets the line number in the query string containing the execution point represented by this stack trace element.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../javax/xml/xquery/XQStackTraceElement.html#getModuleURI()">getModuleURI</A></B>()</CODE> <BR> Gets the module URI containing the execution point represented by this stack trace element.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../javax/xml/xquery/XQStackTraceElement.html#getPosition()">getPosition</A></B>()</CODE> <BR> Gets the character position in the query string containing the execution point represented by this stack trace element.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../javax/xml/xquery/XQStackTraceVariable.html" title="class in javax.xml.xquery">XQStackTraceVariable</A>[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../javax/xml/xquery/XQStackTraceElement.html#getVariables()">getVariables</A></B>()</CODE> <BR> Gets the variables in scope at this execution point, or <code>null</code> if no variable value retrieval is possible.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> </TR> </TABLE> <P> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="XQStackTraceElement(java.lang.String, int, int, int, javax.xml.namespace.QName, javax.xml.xquery.XQStackTraceVariable[])"><!-- --></A><H3> XQStackTraceElement</H3> <PRE> public <B>XQStackTraceElement</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> moduleURI, int line, int column, int position, <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</A> function, <A HREF="../../../javax/xml/xquery/XQStackTraceVariable.html" title="class in javax.xml.xquery">XQStackTraceVariable</A>[] variables)</PRE> <DL> <DD>Construct an <code>XQStackTraceElement</code> object representing a frame in a stack trace. <P> <DL> <DT><B>Parameters:</B><DD><CODE>moduleURI</CODE> - the module URI containing the execution point representing the stack trace element. <code>null</code> when it is the main module or when the module is unknown<DD><CODE>line</CODE> - the line number in the query string where the error occured. Line numbering starts at <code>1</code>. <code>-1</code> if unknown<DD><CODE>column</CODE> - the column number in the query string where the error occured. Column numbering starts at <code>1</code>. <code>-1</code> if unknown<DD><CODE>position</CODE> - the position in the query string where the error occured. This is a <code>0</code> based position. <code>-1<code> if unknown<DD><CODE>function</CODE> - the <code>QName</code> of the function in which the exception occurred, or <code>null</code> if it occurred outside an enclosing function<DD><CODE>variables</CODE> - the variables in scope at this execution point, or <code>null</code> if no variable value retrieval is possible</DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="getModuleURI()"><!-- --></A><H3> getModuleURI</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getModuleURI</B>()</PRE> <DL> <DD>Gets the module URI containing the execution point represented by this stack trace element. <code>null</code> when it is the main module or when the module is unknown. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the module URI containing the excution point represented by the stack trace element or <code>null</code></DL> </DD> </DL> <HR> <A NAME="getPosition()"><!-- --></A><H3> getPosition</H3> <PRE> public int <B>getPosition</B>()</PRE> <DL> <DD>Gets the character position in the query string containing the execution point represented by this stack trace element. <p> This is a <code>0</code> based position. <code>-1</code> if unknown.</li> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the character position in the query string containing the execution point represented by the stack trace element</DL> </DD> </DL> <HR> <A NAME="getLineNumber()"><!-- --></A><H3> getLineNumber</H3> <PRE> public int <B>getLineNumber</B>()</PRE> <DL> <DD>Gets the line number in the query string containing the execution point represented by this stack trace element. <p> Line numbering starts at <code>1</code>. <code>-1</code> is returned if the line number is unknown. If the implementation does not support this method, it must return <code>-1</code> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the line number in the query string containing the execution point represented by the stack trace element</DL> </DD> </DL> <HR> <A NAME="getColumnNumber()"><!-- --></A><H3> getColumnNumber</H3> <PRE> public int <B>getColumnNumber</B>()</PRE> <DL> <DD>Gets the column number in the query string containing the execution point represented by this stack trace element. <p> Column numbering starts at <code>1</code>. <code>-1</code> is returned if the column number is unknown. If the implementation does not support this method, it must return <code>-1</code> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the column number in the query string containing the execution point represented by the stack trace element</DL> </DD> </DL> <HR> <A NAME="getFunctionQName()"><!-- --></A><H3> getFunctionQName</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</A> <B>getFunctionQName</B>()</PRE> <DL> <DD>Gets the <code>QName</code> of the function in which the error occurred, or <code>null</code> if it occurred outside an enclosing function (in a main module). <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the <code>QName</code> of the function in which the error occurred for this stack element or <code>null</code> if it occurred outside an enclosing function</DL> </DD> </DL> <HR> <A NAME="getVariables()"><!-- --></A><H3> getVariables</H3> <PRE> public <A HREF="../../../javax/xml/xquery/XQStackTraceVariable.html" title="class in javax.xml.xquery">XQStackTraceVariable</A>[] <B>getVariables</B>()</PRE> <DL> <DD>Gets the variables in scope at this execution point, or <code>null</code> if no variable value retrieval is possible. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the variables in scope at this execution point, or <code>null</code> if no variable value retrieval is possible.</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../javax/xml/xquery/XQSequenceType.html" title="interface in javax.xml.xquery"><B>PREV CLASS</B></A> <A HREF="../../../javax/xml/xquery/XQStackTraceVariable.html" title="class in javax.xml.xquery"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?javax/xml/xquery/XQStackTraceElement.html" target="_top"><B>FRAMES</B></A> <A HREF="XQStackTraceElement.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> Copyright (c) 2004-2011 Saxonica Limited. All rights reserved. </BODY> </HTML>