nxtOSEK/lejos_nxj/docs/apidocs/lejos/util/Recyclable.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 Mar 27 00:00:25 BST 2007 -->
   6 <TITLE>
   7 Recyclable (leJOS NXT API documentation)
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="lejos.util.Recyclable interface">
  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="Recyclable (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/Assertion.html" title="class in lejos.util"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../lejos/util/RecyclableArray.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/Recyclable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="Recyclable.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;CONSTR&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;CONSTR&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 Interface Recyclable</H2>
  90 <DL>
  91 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../lejos/util/AbstractRecyclable.html" title="class in lejos.util">AbstractRecyclable</A>, <A HREF="../../lejos/util/RecyclableArray.html" title="class in lejos.util">RecyclableArray</A></DD>
  92 </DL>
  93 <HR>
  94 <DL>
  95 <DT><PRE>public interface <B>Recyclable</B></DL>
  96 </PRE>
  97
  98 <P>
  99 Represents a recyclable object.
 100 <P>
 101
 102 <P>
 103 <DL>
 104 <DT><B>See Also:</B><DD><A HREF="../../lejos/util/Recycler.html" title="class in lejos.util"><CODE>Recycler</CODE></A></DL>
 105 <HR>
 106
 107 <P>
 108
 109 <!-- ========== METHOD SUMMARY =========== -->
 110
 111 <A NAME="method_summary"><!-- --></A>
 112 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 113 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 114 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 115 <B>Method Summary</B></FONT></TH>
 116 </TR>
 117 <TR BGCOLOR="white" CLASS="TableRowColor">
 118 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 119 <CODE>&nbsp;<A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util">Recyclable</A></CODE></FONT></TD>
 120 <TD><CODE><B><A HREF="../../lejos/util/Recyclable.html#getNextRecyclable()">getNextRecyclable</A></B>()</CODE>
 121
 122 <BR>
 123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Must return Recyclable most recently set with
 124  <code>setNextRecyclable</code>.</TD>
 125 </TR>
 126 <TR BGCOLOR="white" CLASS="TableRowColor">
 127 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 128 <CODE>&nbsp;void</CODE></FONT></TD>
 129 <TD><CODE><B><A HREF="../../lejos/util/Recyclable.html#init()">init</A></B>()</CODE>
 130
 131 <BR>
 132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when the Recyclable is allocated by a Recycler.</TD>
 133 </TR>
 134 <TR BGCOLOR="white" CLASS="TableRowColor">
 135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 136 <CODE>&nbsp;void</CODE></FONT></TD>
 137 <TD><CODE><B><A HREF="../../lejos/util/Recyclable.html#release()">release</A></B>()</CODE>
 138
 139 <BR>
 140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when this Recyclable is no longer needed.</TD>
 141 </TR>
 142 <TR BGCOLOR="white" CLASS="TableRowColor">
 143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 144 <CODE>&nbsp;void</CODE></FONT></TD>
 145 <TD><CODE><B><A HREF="../../lejos/util/Recyclable.html#setNextRecyclable(lejos.util.Recyclable)">setNextRecyclable</A></B>(<A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util">Recyclable</A>&nbsp;r)</CODE>
 146
 147 <BR>
 148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores a Recyclable object.</TD>
 149 </TR>
 150 </TABLE>
 151 &nbsp;
 152 <P>
 153
 154 <!-- ============ METHOD DETAIL ========== -->
 155
 156 <A NAME="method_detail"><!-- --></A>
 157 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 158 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 159 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 160 <B>Method Detail</B></FONT></TH>
 161 </TR>
 162 </TABLE>
 163
 164 <A NAME="init()"><!-- --></A><H3>
 165 init</H3>
 166 <PRE>
 167 void <B>init</B>()</PRE>
 168 <DL>
 169 <DD>Called when the Recyclable is allocated by a Recycler.
 170 <P>
 171 <DD><DL>
 172 </DL>
 173 </DD>
 174 </DL>
 175 <HR>
 176
 177 <A NAME="release()"><!-- --></A><H3>
 178 release</H3>
 179 <PRE>
 180 void <B>release</B>()</PRE>
 181 <DL>
 182 <DD>Called when this Recyclable is no longer needed.
 183  Resources should be disposed in this method, e.g. this is where
 184  any nested Recyclables would be released.
 185 <P>
 186 <DD><DL>
 187 </DL>
 188 </DD>
 189 </DL>
 190 <HR>
 191
 192 <A NAME="getNextRecyclable()"><!-- --></A><H3>
 193 getNextRecyclable</H3>
 194 <PRE>
 195 <A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util">Recyclable</A> <B>getNextRecyclable</B>()</PRE>
 196 <DL>
 197 <DD>Must return Recyclable most recently set with
 198  <code>setNextRecyclable</code>.
 199 <P>
 200 <DD><DL>
 201 <DT><B>See Also:</B><DD><A HREF="../../lejos/util/Recyclable.html#setNextRecyclable(lejos.util.Recyclable)"><CODE>setNextRecyclable(lejos.util.Recyclable)</CODE></A></DL>
 202 </DD>
 203 </DL>
 204 <HR>
 205
 206 <A NAME="setNextRecyclable(lejos.util.Recyclable)"><!-- --></A><H3>
 207 setNextRecyclable</H3>
 208 <PRE>
 209 void <B>setNextRecyclable</B>(<A HREF="../../lejos/util/Recyclable.html" title="interface in lejos.util">Recyclable</A>&nbsp;r)</PRE>
 210 <DL>
 211 <DD>Stores a Recyclable object.
 212 <P>
 213 <DD><DL>
 214 <DT><B>See Also:</B><DD><A HREF="../../lejos/util/Recyclable.html#getNextRecyclable()"><CODE>getNextRecyclable()</CODE></A></DL>
 215 </DD>
 216 </DL>
 217 <!-- ========= END OF CLASS DATA ========= -->
 218 <HR>
 219
 220
 221 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 222 <A NAME="navbar_bottom"><!-- --></A>
 223 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 224 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 225 <TR>
 226 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 227 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 228 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 229   <TR ALIGN="center" VALIGN="top">
 230   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 231   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 232   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 233   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 234   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 235   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 236   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 237   </TR>
 238 </TABLE>
 239 </TD>
 240 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 241 </EM>
 242 </TD>
 243 </TR>
 244
 245 <TR>
 246 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 247 &nbsp;<A HREF="../../lejos/util/Assertion.html" title="class in lejos.util"><B>PREV CLASS</B></A>&nbsp;
 248 &nbsp;<A HREF="../../lejos/util/RecyclableArray.html" title="class in lejos.util"><B>NEXT CLASS</B></A></FONT></TD>
 249 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 250   <A HREF="../../index.html?lejos/util/Recyclable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 251 &nbsp;<A HREF="Recyclable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 252 &nbsp;<SCRIPT type="text/javascript">
 253   <!--
 254   if(window==top) {
 255     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 256   }
 257   //-->
 258 </SCRIPT>
 259 <NOSCRIPT>
 260   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 261 </NOSCRIPT>
 262
 263
 264 </FONT></TD>
 265 </TR>
 266 <TR>
 267 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 268   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 269 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 270 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 271 </TR>
 272 </TABLE>
 273 <A NAME="skip-navbar_bottom"></A>
 274 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 275
 276 <HR>
 277
 278 </BODY>
 279 </HTML>