Home | History | Annotate | Download | only in base
      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.6.0-google-internal) on Mon Jan 04 20:47:56 PST 2010 -->
      6 <TITLE>
      7 FinalizableReference (Guava Libraries 2010.01.04)
      8 </TITLE>
      9 
     10 <META NAME="date" CONTENT="2010-01-04">
     11 
     12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
     13 
     14 <SCRIPT type="text/javascript">
     15 function windowTitle()
     16 {
     17     if (location.href.indexOf('is-external=true') == -1) {
     18         parent.document.title="FinalizableReference (Guava Libraries 2010.01.04)";
     19     }
     20 }
     21 </SCRIPT>
     22 <NOSCRIPT>
     23 </NOSCRIPT>
     24 
     25 </HEAD>
     26 
     27 <BODY BGCOLOR="white" onload="windowTitle();">
     28 <HR>
     29 
     30 
     31 <!-- ========= START OF TOP NAVBAR ======= -->
     32 <A NAME="navbar_top"><!-- --></A>
     33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
     34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
     35 <TR>
     36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
     37 <A NAME="navbar_top_firstrow"><!-- --></A>
     38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
     39   <TR ALIGN="center" VALIGN="top">
     40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
     41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
     42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
     43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FinalizableReference.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
     44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
     45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
     46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
     47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
     48   </TR>
     49 </TABLE>
     50 </TD>
     51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
     52 </EM>
     53 </TD>
     54 </TR>
     55 
     56 <TR>
     57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     58 &nbsp;<A HREF="../../../../com/google/common/base/FinalizablePhantomReference.html" title="class in com.google.common.base"><B>PREV CLASS</B></A>&nbsp;
     59 &nbsp;<A HREF="../../../../com/google/common/base/FinalizableReferenceQueue.html" title="class in com.google.common.base"><B>NEXT CLASS</B></A></FONT></TD>
     60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     61   <A HREF="../../../../index.html?com/google/common/base/FinalizableReference.html" target="_top"><B>FRAMES</B></A>  &nbsp;
     62 &nbsp;<A HREF="FinalizableReference.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
     63 &nbsp;<SCRIPT type="text/javascript">
     64   <!--
     65   if(window==top) {
     66     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
     67   }
     68   //-->
     69 </SCRIPT>
     70 <NOSCRIPT>
     71   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
     72 </NOSCRIPT>
     73 
     74 
     75 </FONT></TD>
     76 </TR>
     77 <TR>
     78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
     79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
     80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
     81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
     82 </TR>
     83 </TABLE>
     84 <A NAME="skip-navbar_top"></A>
     85 <!-- ========= END OF TOP NAVBAR ========= -->
     86 
     87 <HR>
     88 <!-- ======== START OF CLASS DATA ======== -->
     89 <H2>
     90 <FONT SIZE="-1">
     91 com.google.common.base</FONT>
     92 <BR>
     93 Interface FinalizableReference</H2>
     94 <DL>
     95 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/google/common/base/FinalizablePhantomReference.html" title="class in com.google.common.base">FinalizablePhantomReference</A>, <A HREF="../../../../com/google/common/base/FinalizableSoftReference.html" title="class in com.google.common.base">FinalizableSoftReference</A>, <A HREF="../../../../com/google/common/base/FinalizableWeakReference.html" title="class in com.google.common.base">FinalizableWeakReference</A></DD>
     96 </DL>
     97 <HR>
     98 <DL>
     99 <DT><PRE>public interface <B>FinalizableReference</B></DL>
    100 </PRE>
    101 
    102 <P>
    103 Implemented by references that have code to run after garbage collection of
    104  their referents.
    105 <P>
    106 
    107 <P>
    108 <DL>
    109 <DT><B>Since:</B></DT>
    110   <DD>2010.01.04 <b>stable</b> (imported from Google Collections Library)</DD>
    111 <DT><B>Author:</B></DT>
    112   <DD>Bob Lee</DD>
    113 <DT><B>See Also:</B><DD><A HREF="../../../../com/google/common/base/FinalizableReferenceQueue.html" title="class in com.google.common.base"><CODE>FinalizableReferenceQueue</CODE></A></DL>
    114 <HR>
    115 
    116 <P>
    117 
    118 <!-- ========== METHOD SUMMARY =========== -->
    119 
    120 <A NAME="method_summary"><!-- --></A>
    121 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    122 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    123 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    124 <B>Method Summary</B></FONT></TH>
    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="../../../../com/google/common/base/FinalizableReference.html#finalizeReferent()">finalizeReferent</A></B>()</CODE>
    130 
    131 <BR>
    132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Invoked on a background thread after the referent has been garbage
    133  collected unless security restrictions prevented starting a background
    134  thread, in which case this method is invoked when new references
    135  are created.</TD>
    136 </TR>
    137 </TABLE>
    138 &nbsp;
    139 <P>
    140 
    141 <!-- ============ METHOD DETAIL ========== -->
    142 
    143 <A NAME="method_detail"><!-- --></A>
    144 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    145 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    146 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    147 <B>Method Detail</B></FONT></TH>
    148 </TR>
    149 </TABLE>
    150 
    151 <A NAME="finalizeReferent()"><!-- --></A><H3>
    152 finalizeReferent</H3>
    153 <PRE>
    154 void <B>finalizeReferent</B>()</PRE>
    155 <DL>
    156 <DD>Invoked on a background thread after the referent has been garbage
    157  collected unless security restrictions prevented starting a background
    158  thread, in which case this method is invoked when new references
    159  are created.
    160 <P>
    161 <DD><DL>
    162 </DL>
    163 </DD>
    164 </DL>
    165 <!-- ========= END OF CLASS DATA ========= -->
    166 <HR>
    167 
    168 
    169 <!-- ======= START OF BOTTOM NAVBAR ====== -->
    170 <A NAME="navbar_bottom"><!-- --></A>
    171 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    172 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    173 <TR>
    174 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    175 <A NAME="navbar_bottom_firstrow"><!-- --></A>
    176 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    177   <TR ALIGN="center" VALIGN="top">
    178   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    179   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    180   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    181   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FinalizableReference.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    182   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    183   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    184   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    185   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    186   </TR>
    187 </TABLE>
    188 </TD>
    189 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    190 </EM>
    191 </TD>
    192 </TR>
    193 
    194 <TR>
    195 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    196 &nbsp;<A HREF="../../../../com/google/common/base/FinalizablePhantomReference.html" title="class in com.google.common.base"><B>PREV CLASS</B></A>&nbsp;
    197 &nbsp;<A HREF="../../../../com/google/common/base/FinalizableReferenceQueue.html" title="class in com.google.common.base"><B>NEXT CLASS</B></A></FONT></TD>
    198 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    199   <A HREF="../../../../index.html?com/google/common/base/FinalizableReference.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    200 &nbsp;<A HREF="FinalizableReference.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    201 &nbsp;<SCRIPT type="text/javascript">
    202   <!--
    203   if(window==top) {
    204     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    205   }
    206   //-->
    207 </SCRIPT>
    208 <NOSCRIPT>
    209   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    210 </NOSCRIPT>
    211 
    212 
    213 </FONT></TD>
    214 </TR>
    215 <TR>
    216 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    217   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    218 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    219 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    220 </TR>
    221 </TABLE>
    222 <A NAME="skip-navbar_bottom"></A>
    223 <!-- ======== END OF BOTTOM NAVBAR ======= -->
    224 
    225 <HR>
    226 
    227 </BODY>
    228 </HTML>
    229