| <!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.5.0_18) on Sun Apr 01 21:18:40 PDT 2012 --> | |
| <TITLE> | |
| IteratorPool | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.xpath.axes.IteratorPool class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="IteratorPool"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= 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="class-use/IteratorPool.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../../org/apache/xpath/axes/HasPositionalPredChecker.html" title="class in org.apache.xpath.axes"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html" title="class in org.apache.xpath.axes"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/xpath/axes/IteratorPool.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="IteratorPool.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <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"> | |
| org.apache.xpath.axes</FONT> | |
| <BR> | |
| Class IteratorPool</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xpath.axes.IteratorPool</B> | |
| </PRE> | |
| <DL> | |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public final class <A HREF="../../../../src-html/org/apache/xpath/axes/IteratorPool.html#line.32"><B>IteratorPool</B></A><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL> | |
| </PRE> | |
| <P> | |
| Pool of object of a given type to pick from to help memory usage | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.xpath.axes.IteratorPool">Serialized Form</A></DL> | |
| <HR> | |
| <P> | |
| <!-- =========== FIELD SUMMARY =========== --> | |
| <A NAME="field_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>Field Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private java.util.ArrayList</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/IteratorPool.html#m_freeStack">m_freeStack</A></B></CODE> | |
| <BR> | |
| Stack of given objects this points to.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/IteratorPool.html#m_orig">m_orig</A></B></CODE> | |
| <BR> | |
| Type of objects in this pool.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>(package private) static long</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/IteratorPool.html#serialVersionUID">serialVersionUID</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <!-- ======== 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="../../../../org/apache/xpath/axes/IteratorPool.html#IteratorPool(org.apache.xml.dtm.DTMIterator)">IteratorPool</A></B>(<A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> original)</CODE> | |
| <BR> | |
| Constructor IteratorPool</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> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/IteratorPool.html#freeInstance(org.apache.xml.dtm.DTMIterator)">freeInstance</A></B>(<A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> obj)</CODE> | |
| <BR> | |
| Add an instance of the given object to the pool</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/IteratorPool.html#getInstance()">getInstance</A></B>()</CODE> | |
| <BR> | |
| Get an instance of the given object in this pool</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/IteratorPool.html#getInstanceOrThrow()">getInstanceOrThrow</A></B>()</CODE> | |
| <BR> | |
| Get an instance of the given object in this pool</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.Object</B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ============ FIELD DETAIL =========== --> | |
| <A NAME="field_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>Field Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="serialVersionUID"><!-- --></A><H3> | |
| serialVersionUID</H3> | |
| <PRE> | |
| static final long <A HREF="../../../../src-html/org/apache/xpath/axes/IteratorPool.html#line.34"><B>serialVersionUID</B></A></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xpath.axes.IteratorPool.serialVersionUID">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_orig"><!-- --></A><H3> | |
| m_orig</H3> | |
| <PRE> | |
| private final <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> <A HREF="../../../../src-html/org/apache/xpath/axes/IteratorPool.html#line.39"><B>m_orig</B></A></PRE> | |
| <DL> | |
| <DD>Type of objects in this pool. | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_freeStack"><!-- --></A><H3> | |
| m_freeStack</H3> | |
| <PRE> | |
| private final java.util.ArrayList <A HREF="../../../../src-html/org/apache/xpath/axes/IteratorPool.html#line.44"><B>m_freeStack</B></A></PRE> | |
| <DL> | |
| <DD>Stack of given objects this points to. | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <!-- ========= 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="IteratorPool(org.apache.xml.dtm.DTMIterator)"><!-- --></A><H3> | |
| IteratorPool</H3> | |
| <PRE> | |
| public <A HREF="../../../../src-html/org/apache/xpath/axes/IteratorPool.html#line.51"><B>IteratorPool</B></A>(<A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> original)</PRE> | |
| <DL> | |
| <DD>Constructor IteratorPool | |
| <P> | |
| <DL> | |
| <DT><B>Parameters:</B><DD><CODE>original</CODE> - The original iterator from which all others will be cloned.</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="getInstanceOrThrow()"><!-- --></A><H3> | |
| getInstanceOrThrow</H3> | |
| <PRE> | |
| public <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> <A HREF="../../../../src-html/org/apache/xpath/axes/IteratorPool.html#line.62"><B>getInstanceOrThrow</B></A>() | |
| throws java.lang.CloneNotSupportedException</PRE> | |
| <DL> | |
| <DD>Get an instance of the given object in this pool | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>An instance of the given object | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.lang.CloneNotSupportedException</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getInstance()"><!-- --></A><H3> | |
| getInstance</H3> | |
| <PRE> | |
| public <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> <A HREF="../../../../src-html/org/apache/xpath/axes/IteratorPool.html#line.85"><B>getInstance</B></A>()</PRE> | |
| <DL> | |
| <DD>Get an instance of the given object in this pool | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>An instance of the given object</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="freeInstance(org.apache.xml.dtm.DTMIterator)"><!-- --></A><H3> | |
| freeInstance</H3> | |
| <PRE> | |
| public void <A HREF="../../../../src-html/org/apache/xpath/axes/IteratorPool.html#line.115"><B>freeInstance</B></A>(<A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> obj)</PRE> | |
| <DL> | |
| <DD>Add an instance of the given object to the pool | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>obj</CODE> - Object to add.</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="class-use/IteratorPool.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../../org/apache/xpath/axes/HasPositionalPredChecker.html" title="class in org.apache.xpath.axes"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html" title="class in org.apache.xpath.axes"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/xpath/axes/IteratorPool.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="IteratorPool.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <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> | |
| </BODY> | |
| </HTML> |