nxtOSEK/lejos_nxj/docs/apidocs/lejos/util/Recycler.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.5.0_09) on Tue Jan 08 20:46:02 GMT 2008 -->
   6 <TITLE>
   7 Recycler (leJOS NXT API documentation)
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="lejos.util.Recycler class">
  11
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
  13
  14 <SCRIPT type="text/javascript">
  15 function windowTitle()
  16 {
  17     parent.document.title="Recycler (leJOS NXT API documentation)";
  18 }
  19 </SCRIPT>
  20 <NOSCRIPT>
  21 </NOSCRIPT>
  22
  23 </HEAD>
  24
  25 <BODY BGCOLOR="white" onload="windowTitle();">
  26
  27
  28 <!-- ========= START OF TOP NAVBAR ======= -->
  29 <A NAME="navbar_top"><!-- --></A>
  30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  32 <TR>
  33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  34 <A NAME="navbar_top_firstrow"><!-- --></A>
  35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  36   <TR ALIGN="center" VALIGN="top">
  37   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  39   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  44   </TR>
  45 </TABLE>
  46 </TD>
  47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  48 </EM>
  49 </TD>
  50 </TR>
  51
  52 <TR>
  53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54 &nbsp;<A HREF="../../lejos/util/RecyclableArray.html" title="class in lejos.util"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../lejos/util/Timer.html" title="class in lejos.util"><B>NEXT CLASS</B></A></FONT></TD>
  56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  57   <A HREF="../../index.html?lejos/util/Recycler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="Recycler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  59 &nbsp;<SCRIPT type="text/javascript">
  60   <!--
  61   if(window==top) {
  62     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  63   }
  64   //-->
  65 </SCRIPT>
  66 <NOSCRIPT>
  67   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  68 </NOSCRIPT>
  69
  70
  71 </FONT></TD>
  72 </TR>
  73 <TR>
  74 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  75   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  77 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  78 </TR>
  79 </TABLE>
  80 <A NAME="skip-navbar_top"></A>
  81 <!-- ========= END OF TOP NAVBAR ========= -->
  82
  83 <HR>
  84 <!-- ======== START OF CLASS DATA ======== -->
  85 <H2>
  86 <FONT SIZE="-1">
  87 lejos.util</FONT>
  88 <BR>
  89 Class Recycler</H2>
  90 <PRE>
  91 <A HREF="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</A>
  92   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>lejos.util.Recycler</B>
  93 </PRE>
  94 <DL>
  95 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../lejos/util/ArrayRecycler.html" title="class in lejos.util">ArrayRecycler</A></DD>
  96 </DL>
  97 <HR>
  98 <DL>
  99 <DT><PRE>public abstract class <B>Recycler</B><DT>extends <A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></DL>
 100 </PRE>
 101
 102 <P>
 103 An abstract object recycler. This class should
 104  be extended to define the <code>createInstance</code>
 105  method for a particular kind of <code>Recyclable</code>.
 106  On concrete recycler instances, invoke
 107  <code>allocate()</code> to create objects
 108  and <code>recycle()</code> to release them.
 109  It is the programmer's responsibility to
 110  avoid using objects that have been recycled.
 111  <p>
 112  Note that the caller is expected to provide
 113  thread safety for instances of this class.
 114 <P>
 115
 116 <P>
 117 <DL>
 118 <DT><B>See Also:</B><DD><A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util"><CODE>Recyclable</CODE></A></DL>
 119 <HR>
 120
 121 <P>
 122
 123 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 124
 125 <A NAME="constructor_summary"><!-- --></A>
 126 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 127 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 128 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 129 <B>Constructor Summary</B></FONT></TH>
 130 </TR>
 131 <TR BGCOLOR="white" CLASS="TableRowColor">
 132 <TD><CODE><B><A HREF="../../lejos/util/Recycler.html#Recycler()">Recycler</A></B>()</CODE>
 133
 134 <BR>
 135 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a recycler.</TD>
 136 </TR>
 137 </TABLE>
 138 &nbsp;
 139 <!-- ========== METHOD SUMMARY =========== -->
 140
 141 <A NAME="method_summary"><!-- --></A>
 142 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 143 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 144 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 145 <B>Method Summary</B></FONT></TH>
 146 </TR>
 147 <TR BGCOLOR="white" CLASS="TableRowColor">
 148 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 149 <CODE>&nbsp;<A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util">Recyclable</A></CODE></FONT></TD>
 150 <TD><CODE><B><A HREF="../../lejos/util/Recycler.html#allocate()">allocate</A></B>()</CODE>
 151
 152 <BR>
 153 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attempts to obtain a free object.</TD>
 154 </TR>
 155 <TR BGCOLOR="white" CLASS="TableRowColor">
 156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 157 <CODE>protected abstract &nbsp;<A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util">Recyclable</A></CODE></FONT></TD>
 158 <TD><CODE><B><A HREF="../../lejos/util/Recycler.html#createInstance()">createInstance</A></B>()</CODE>
 159
 160 <BR>
 161 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is a factory method that should be
 162  overridden to create an Recyclable object instance.</TD>
 163 </TR>
 164 <TR BGCOLOR="white" CLASS="TableRowColor">
 165 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 166 <CODE>&nbsp;void</CODE></FONT></TD>
 167 <TD><CODE><B><A HREF="../../lejos/util/Recycler.html#recycle(lejos.util.Recyclable)">recycle</A></B>(<A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util">Recyclable</A>&nbsp;r)</CODE>
 168
 169 <BR>
 170 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reclaims a Recyclable previously allocated
 171  with the <code>allocate</code> method.</TD>
 172 </TR>
 173 </TABLE>
 174 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 175 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 176 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 177 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></B></TH>
 178 </TR>
 179 <TR BGCOLOR="white" CLASS="TableRowColor">
 180 <TD><CODE><A HREF="../../java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="../../java/lang/Object.html#getClass()">getClass</A>, <A HREF="../../java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="../../java/lang/Object.html#notify()">notify</A>, <A HREF="../../java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="../../java/lang/Object.html#toString()">toString</A>, <A HREF="../../java/lang/Object.html#wait()">wait</A>, <A HREF="../../java/lang/Object.html#wait(long)">wait</A></CODE></TD>
 181 </TR>
 182 </TABLE>
 183 &nbsp;
 184 <P>
 185
 186 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 187
 188 <A NAME="constructor_detail"><!-- --></A>
 189 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 190 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 191 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 192 <B>Constructor Detail</B></FONT></TH>
 193 </TR>
 194 </TABLE>
 195
 196 <A NAME="Recycler()"><!-- --></A><H3>
 197 Recycler</H3>
 198 <PRE>
 199 public <B>Recycler</B>()</PRE>
 200 <DL>
 201 <DD>Constructs a recycler.
 202 <P>
 203 </DL>
 204
 205 <!-- ============ METHOD DETAIL ========== -->
 206
 207 <A NAME="method_detail"><!-- --></A>
 208 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 209 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 210 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 211 <B>Method Detail</B></FONT></TH>
 212 </TR>
 213 </TABLE>
 214
 215 <A NAME="allocate()"><!-- --></A><H3>
 216 allocate</H3>
 217 <PRE>
 218 public final <A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util">Recyclable</A> <B>allocate</B>()</PRE>
 219 <DL>
 220 <DD>Attempts to obtain a free object.
 221 <P>
 222 <DD><DL>
 223
 224 <DT><B>Returns:</B><DD>A Recyclable object reference.</DL>
 225 </DD>
 226 </DL>
 227 <HR>
 228
 229 <A NAME="recycle(lejos.util.Recyclable)"><!-- --></A><H3>
 230 recycle</H3>
 231 <PRE>
 232 public final void <B>recycle</B>(<A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util">Recyclable</A>&nbsp;r)</PRE>
 233 <DL>
 234 <DD>Reclaims a Recyclable previously allocated
 235  with the <code>allocate</code> method.
 236  The <code>release</code> method of the Recyclable object
 237  is invoked here.
 238 <P>
 239 <DD><DL>
 240 </DL>
 241 </DD>
 242 </DL>
 243 <HR>
 244
 245 <A NAME="createInstance()"><!-- --></A><H3>
 246 createInstance</H3>
 247 <PRE>
 248 protected abstract <A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util">Recyclable</A> <B>createInstance</B>()</PRE>
 249 <DL>
 250 <DD>This is a factory method that should be
 251  overridden to create an Recyclable object instance.
 252 <P>
 253 <DD><DL>
 254 </DL>
 255 </DD>
 256 </DL>
 257 <!-- ========= END OF CLASS DATA ========= -->
 258 <HR>
 259
 260
 261 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 262 <A NAME="navbar_bottom"><!-- --></A>
 263 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 264 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 265 <TR>
 266 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 267 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 268 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 269   <TR ALIGN="center" VALIGN="top">
 270   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 271   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 272   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 273   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 274   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 275   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 276   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 277   </TR>
 278 </TABLE>
 279 </TD>
 280 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 281 </EM>
 282 </TD>
 283 </TR>
 284
 285 <TR>
 286 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 287 &nbsp;<A HREF="../../lejos/util/RecyclableArray.html" title="class in lejos.util"><B>PREV CLASS</B></A>&nbsp;
 288 &nbsp;<A HREF="../../lejos/util/Timer.html" title="class in lejos.util"><B>NEXT CLASS</B></A></FONT></TD>
 289 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 290   <A HREF="../../index.html?lejos/util/Recycler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 291 &nbsp;<A HREF="Recycler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 292 &nbsp;<SCRIPT type="text/javascript">
 293   <!--
 294   if(window==top) {
 295     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 296   }
 297   //-->
 298 </SCRIPT>
 299 <NOSCRIPT>
 300   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 301 </NOSCRIPT>
 302
 303
 304 </FONT></TD>
 305 </TR>
 306 <TR>
 307 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 308   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 309 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 310 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 311 </TR>
 312 </TABLE>
 313 <A NAME="skip-navbar_bottom"></A>
 314 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 315
 316 <HR>
 317
 318 </BODY>
 319 </HTML>