nxtOSEK/lejos_nxj/docs/apidocs/lejos/util/ArrayRecycler.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 ArrayRecycler (leJOS NXT API documentation)
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="lejos.util.ArrayRecycler 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="ArrayRecycler (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/AbstractRecyclable.html" title="class in lejos.util"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../lejos/util/Assertion.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/ArrayRecycler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="ArrayRecycler.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 ArrayRecycler</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 "><A HREF="../../lejos/util/Recycler.html" title="class in lejos.util">lejos.util.Recycler</A>
  93       <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>lejos.util.ArrayRecycler</B>
  94 </PRE>
  95 <HR>
  96 <DL>
  97 <DT><PRE>public final class <B>ArrayRecycler</B><DT>extends <A HREF="../../lejos/util/Recycler.html" title="class in lejos.util">Recycler</A></DL>
  98 </PRE>
  99
 100 <P>
 101 An array recycler for Object arrays. To use this utility, create
 102  a global instance of this class, and then invoke
 103  <code>allocate(int)</code> to create recyclable arrays.
 104  As usual, invoke <code>recycle(...)</code> to release the array.
 105  <p>
 106  Note that the caller is expected to provide
 107  thread safety for instances of this class.
 108 <P>
 109
 110 <P>
 111 <DL>
 112 <DT><B>See Also:</B><DD><A HREF="../../lejos/util/RecyclableArray.html" title="class in lejos.util"><CODE>RecyclableArray</CODE></A></DL>
 113 <HR>
 114
 115 <P>
 116
 117 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 118
 119 <A NAME="constructor_summary"><!-- --></A>
 120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 121 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 122 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 123 <B>Constructor Summary</B></FONT></TH>
 124 </TR>
 125 <TR BGCOLOR="white" CLASS="TableRowColor">
 126 <TD><CODE><B><A HREF="../../lejos/util/ArrayRecycler.html#ArrayRecycler()">ArrayRecycler</A></B>()</CODE>
 127
 128 <BR>
 129 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a recycler.</TD>
 130 </TR>
 131 </TABLE>
 132 &nbsp;
 133 <!-- ========== METHOD SUMMARY =========== -->
 134
 135 <A NAME="method_summary"><!-- --></A>
 136 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 137 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 138 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 139 <B>Method Summary</B></FONT></TH>
 140 </TR>
 141 <TR BGCOLOR="white" CLASS="TableRowColor">
 142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 143 <CODE>&nbsp;<A HREF="../../lejos/util/RecyclableArray.html" title="class in lejos.util">RecyclableArray</A></CODE></FONT></TD>
 144 <TD><CODE><B><A HREF="../../lejos/util/ArrayRecycler.html#allocate(int)">allocate</A></B>(int&nbsp;length)</CODE>
 145
 146 <BR>
 147 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attempts to obtain a free RecyclableArray.</TD>
 148 </TR>
 149 <TR BGCOLOR="white" CLASS="TableRowColor">
 150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 151 <CODE>protected &nbsp;<A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util">Recyclable</A></CODE></FONT></TD>
 152 <TD><CODE><B><A HREF="../../lejos/util/ArrayRecycler.html#createInstance()">createInstance</A></B>()</CODE>
 153
 154 <BR>
 155 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is a factory method that should be
 156  overridden to create an Recyclable object instance.</TD>
 157 </TR>
 158 </TABLE>
 159 &nbsp;<A NAME="methods_inherited_from_class_lejos.util.Recycler"><!-- --></A>
 160 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 161 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 162 <TH ALIGN="left"><B>Methods inherited from class lejos.util.<A HREF="../../lejos/util/Recycler.html" title="class in lejos.util">Recycler</A></B></TH>
 163 </TR>
 164 <TR BGCOLOR="white" CLASS="TableRowColor">
 165 <TD><CODE><A HREF="../../lejos/util/Recycler.html#allocate()">allocate</A>, <A HREF="../../lejos/util/Recycler.html#recycle(lejos.util.Recyclable)">recycle</A></CODE></TD>
 166 </TR>
 167 </TABLE>
 168 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 169 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 170 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 171 <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>
 172 </TR>
 173 <TR BGCOLOR="white" CLASS="TableRowColor">
 174 <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>
 175 </TR>
 176 </TABLE>
 177 &nbsp;
 178 <P>
 179
 180 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 181
 182 <A NAME="constructor_detail"><!-- --></A>
 183 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 184 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 185 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 186 <B>Constructor Detail</B></FONT></TH>
 187 </TR>
 188 </TABLE>
 189
 190 <A NAME="ArrayRecycler()"><!-- --></A><H3>
 191 ArrayRecycler</H3>
 192 <PRE>
 193 public <B>ArrayRecycler</B>()</PRE>
 194 <DL>
 195 <DD>Constructs a recycler.
 196 <P>
 197 </DL>
 198
 199 <!-- ============ METHOD DETAIL ========== -->
 200
 201 <A NAME="method_detail"><!-- --></A>
 202 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 203 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 204 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 205 <B>Method Detail</B></FONT></TH>
 206 </TR>
 207 </TABLE>
 208
 209 <A NAME="allocate(int)"><!-- --></A><H3>
 210 allocate</H3>
 211 <PRE>
 212 public final <A HREF="../../lejos/util/RecyclableArray.html" title="class in lejos.util">RecyclableArray</A> <B>allocate</B>(int&nbsp;length)</PRE>
 213 <DL>
 214 <DD>Attempts to obtain a free RecyclableArray.
 215 <P>
 216 <DD><DL>
 217
 218 <DT><B>Returns:</B><DD>A RecyclableArray reference.
 219 <DT><B>Throws:</B>
 220 <DD><CODE><A HREF="../../java/lang/StackOverflowError.html" title="class in java.lang">StackOverflowError</A></CODE> - May be thrown due to the recursive implementation of the method.</DL>
 221 </DD>
 222 </DL>
 223 <HR>
 224
 225 <A NAME="createInstance()"><!-- --></A><H3>
 226 createInstance</H3>
 227 <PRE>
 228 protected final <A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util">Recyclable</A> <B>createInstance</B>()</PRE>
 229 <DL>
 230 <DD><B>Description copied from class: <CODE><A HREF="../../lejos/util/Recycler.html#createInstance()">Recycler</A></CODE></B></DD>
 231 <DD>This is a factory method that should be
 232  overridden to create an Recyclable object instance.
 233 <P>
 234 <DD><DL>
 235 <DT><B>Specified by:</B><DD><CODE><A HREF="../../lejos/util/Recycler.html#createInstance()">createInstance</A></CODE> in class <CODE><A HREF="../../lejos/util/Recycler.html" title="class in lejos.util">Recycler</A></CODE></DL>
 236 </DD>
 237 <DD><DL>
 238 </DL>
 239 </DD>
 240 </DL>
 241 <!-- ========= END OF CLASS DATA ========= -->
 242 <HR>
 243
 244
 245 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 246 <A NAME="navbar_bottom"><!-- --></A>
 247 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 248 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 249 <TR>
 250 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 251 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 252 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 253   <TR ALIGN="center" VALIGN="top">
 254   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 255   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 256   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 257   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 258   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 259   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 260   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 261   </TR>
 262 </TABLE>
 263 </TD>
 264 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 265 </EM>
 266 </TD>
 267 </TR>
 268
 269 <TR>
 270 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 271 &nbsp;<A HREF="../../lejos/util/AbstractRecyclable.html" title="class in lejos.util"><B>PREV CLASS</B></A>&nbsp;
 272 &nbsp;<A HREF="../../lejos/util/Assertion.html" title="class in lejos.util"><B>NEXT CLASS</B></A></FONT></TD>
 273 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 274   <A HREF="../../index.html?lejos/util/ArrayRecycler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 275 &nbsp;<A HREF="ArrayRecycler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 276 &nbsp;<SCRIPT type="text/javascript">
 277   <!--
 278   if(window==top) {
 279     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 280   }
 281   //-->
 282 </SCRIPT>
 283 <NOSCRIPT>
 284   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 285 </NOSCRIPT>
 286
 287
 288 </FONT></TD>
 289 </TR>
 290 <TR>
 291 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 292   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 293 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 294 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 295 </TR>
 296 </TABLE>
 297 <A NAME="skip-navbar_bottom"></A>
 298 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 299
 300 <HR>
 301
 302 </BODY>
 303 </HTML>