<!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:38 PDT 2012 --> | |
<TITLE> | |
ObjectPool | |
</TITLE> | |
<META NAME="keywords" CONTENT="org.apache.xml.utils.ObjectPool class"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
parent.document.title="ObjectPool"; | |
} | |
</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/ObjectPool.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/xml/utils/ObjectFactory.ConfigurationError.html" title="class in org.apache.xml.utils"><B>PREV CLASS</B></A> | |
<A HREF="../../../../org/apache/xml/utils/ObjectStack.html" title="class in org.apache.xml.utils"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../index.html?org/apache/xml/utils/ObjectPool.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="ObjectPool.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.xml.utils</FONT> | |
<BR> | |
Class ObjectPool</H2> | |
<PRE> | |
java.lang.Object | |
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xml.utils.ObjectPool</B> | |
</PRE> | |
<DL> | |
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> | |
</DL> | |
<HR> | |
<DL> | |
<DT><PRE>public class <A HREF="../../../../src-html/org/apache/xml/utils/ObjectPool.html#line.33"><B>ObjectPool</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.xml.utils.ObjectPool">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/xml/utils/ObjectPool.html#freeStack">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 java.lang.Class</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/ObjectPool.html#objectType">objectType</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/xml/utils/ObjectPool.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/xml/utils/ObjectPool.html#ObjectPool()">ObjectPool</A></B>()</CODE> | |
<BR> | |
Constructor ObjectPool</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/ObjectPool.html#ObjectPool(java.lang.Class)">ObjectPool</A></B>(java.lang.Class type)</CODE> | |
<BR> | |
Constructor ObjectPool</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/ObjectPool.html#ObjectPool(java.lang.Class, int)">ObjectPool</A></B>(java.lang.Class type, | |
int size)</CODE> | |
<BR> | |
Constructor ObjectPool</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/ObjectPool.html#ObjectPool(java.lang.String)">ObjectPool</A></B>(java.lang.String className)</CODE> | |
<BR> | |
Constructor ObjectPool</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/xml/utils/ObjectPool.html#freeInstance(java.lang.Object)">freeInstance</A></B>(java.lang.Object 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> java.lang.Object</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/ObjectPool.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> java.lang.Object</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/xml/utils/ObjectPool.html#getInstanceIfFree()">getInstanceIfFree</A></B>()</CODE> | |
<BR> | |
Get an instance of the given object in this pool if available</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/xml/utils/ObjectPool.html#line.35"><B>serialVersionUID</B></A></PRE> | |
<DL> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.utils.ObjectPool.serialVersionUID">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="objectType"><!-- --></A><H3> | |
objectType</H3> | |
<PRE> | |
private final java.lang.Class <A HREF="../../../../src-html/org/apache/xml/utils/ObjectPool.html#line.39"><B>objectType</B></A></PRE> | |
<DL> | |
<DD>Type of objects in this pool. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="freeStack"><!-- --></A><H3> | |
freeStack</H3> | |
<PRE> | |
private final java.util.ArrayList <A HREF="../../../../src-html/org/apache/xml/utils/ObjectPool.html#line.43"><B>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="ObjectPool(java.lang.Class)"><!-- --></A><H3> | |
ObjectPool</H3> | |
<PRE> | |
public <A HREF="../../../../src-html/org/apache/xml/utils/ObjectPool.html#line.50"><B>ObjectPool</B></A>(java.lang.Class type)</PRE> | |
<DL> | |
<DD>Constructor ObjectPool | |
<P> | |
<DL> | |
<DT><B>Parameters:</B><DD><CODE>type</CODE> - Type of objects for this pool</DL> | |
</DL> | |
<HR> | |
<A NAME="ObjectPool(java.lang.String)"><!-- --></A><H3> | |
ObjectPool</H3> | |
<PRE> | |
public <A HREF="../../../../src-html/org/apache/xml/utils/ObjectPool.html#line.61"><B>ObjectPool</B></A>(java.lang.String className)</PRE> | |
<DL> | |
<DD>Constructor ObjectPool | |
<P> | |
<DL> | |
<DT><B>Parameters:</B><DD><CODE>className</CODE> - Fully qualified name of the type of objects for this pool.</DL> | |
</DL> | |
<HR> | |
<A NAME="ObjectPool(java.lang.Class, int)"><!-- --></A><H3> | |
ObjectPool</H3> | |
<PRE> | |
public <A HREF="../../../../src-html/org/apache/xml/utils/ObjectPool.html#line.83"><B>ObjectPool</B></A>(java.lang.Class type, | |
int size)</PRE> | |
<DL> | |
<DD>Constructor ObjectPool | |
<P> | |
<DL> | |
<DT><B>Parameters:</B><DD><CODE>type</CODE> - Type of objects for this pool<DD><CODE>size</CODE> - Size of vector to allocate</DL> | |
</DL> | |
<HR> | |
<A NAME="ObjectPool()"><!-- --></A><H3> | |
ObjectPool</H3> | |
<PRE> | |
public <A HREF="../../../../src-html/org/apache/xml/utils/ObjectPool.html#line.93"><B>ObjectPool</B></A>()</PRE> | |
<DL> | |
<DD>Constructor ObjectPool | |
<P> | |
</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="getInstanceIfFree()"><!-- --></A><H3> | |
getInstanceIfFree</H3> | |
<PRE> | |
public java.lang.Object <A HREF="../../../../src-html/org/apache/xml/utils/ObjectPool.html#line.105"><B>getInstanceIfFree</B></A>()</PRE> | |
<DL> | |
<DD>Get an instance of the given object in this pool if available | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>an instance of the given object if available or null</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getInstance()"><!-- --></A><H3> | |
getInstance</H3> | |
<PRE> | |
public java.lang.Object <A HREF="../../../../src-html/org/apache/xml/utils/ObjectPool.html#line.126"><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(java.lang.Object)"><!-- --></A><H3> | |
freeInstance</H3> | |
<PRE> | |
public void <A HREF="../../../../src-html/org/apache/xml/utils/ObjectPool.html#line.160"><B>freeInstance</B></A>(java.lang.Object 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/ObjectPool.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/xml/utils/ObjectFactory.ConfigurationError.html" title="class in org.apache.xml.utils"><B>PREV CLASS</B></A> | |
<A HREF="../../../../org/apache/xml/utils/ObjectStack.html" title="class in org.apache.xml.utils"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../index.html?org/apache/xml/utils/ObjectPool.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="ObjectPool.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> |