/lib/commons-io/apidocs/org/apache/commons/io/FileCleaner.html

https://bitbucket.org/arkban/somersault · HTML · 510 lines · 437 code · 49 blank · 24 comment · 0 complexity · b90b55d37e88cf41d26ac045de904011 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.6.0_20) on Tue Sep 28 21:40:06 EDT 2010 -->
    6. 

  6. <TITLE>
    7. 

  7. FileCleaner (Commons IO 1.5-SNAPSHOT)
    8. 

  8. </TITLE>
    9. 

  9. 

  10. <META NAME="date" CONTENT="2010-09-28">
    11. 

  11. 

  12. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
    13. 

  13. 

  14. <SCRIPT type="text/javascript">
    15. 

  15. function windowTitle()
    16. 

  16. {
    17. 

  17.     if (location.href.indexOf('is-external=true') == -1) {
    18. 

  18.         parent.document.title="FileCleaner (Commons IO 1.5-SNAPSHOT)";
    19. 

  19.     }
    20. 

  20. }
    21. 

  21. </SCRIPT>
    22. 

  22. <NOSCRIPT>
    23. 

  23. </NOSCRIPT>
    24. 

  24. 

  25. </HEAD>
    26. 

  26. 

  27. <BODY BGCOLOR="white" onload="windowTitle();">
    28. 

  28. <HR>
    29. 

  29. 

  30. 

  31. <!-- ========= START OF TOP NAVBAR ======= -->
    32. 

  32. <A NAME="navbar_top"><!-- --></A>
    33. 

  33. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    34. 

  34. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    35. 

  35. <TR>
    36. 

  36. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    37. 

  37. <A NAME="navbar_top_firstrow"><!-- --></A>
    38. 

  38. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    39. 

  39.   <TR ALIGN="center" VALIGN="top">
    40. 

  40.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    41. 

  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    42. 

  42.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    43. 

  43.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    44. 

  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    45. 

  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    46. 

  46.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    47. 

  47.   </TR>
    48. 

  48. </TABLE>
    49. 

  49. </TD>
    50. 

  50. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    51. 

  51. </EM>
    52. 

  52. </TD>
    53. 

  53. </TR>
    54. 

  54. 

  55. <TR>
    56. 

  56. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    57. 

  57. &nbsp;<A HREF="../../../../org/apache/commons/io/EndianUtils.html" title="class in org.apache.commons.io"><B>PREV CLASS</B></A>&nbsp;
    58. 

  58. &nbsp;<A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io"><B>NEXT CLASS</B></A></FONT></TD>
    59. 

  59. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    60. 

  60.   <A HREF="../../../../index.html?org/apache/commons/io/FileCleaner.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    61. 

  61. &nbsp;<A HREF="FileCleaner.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    62. 

  62. &nbsp;<SCRIPT type="text/javascript">
    63. 

  63.   <!--
    64. 

  64.   if(window==top) {
    65. 

  65.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    66. 

  66.   }
    67. 

  67.   //-->
    68. 

  68. </SCRIPT>
    69. 

  69. <NOSCRIPT>
    70. 

  70.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    71. 

  71. </NOSCRIPT>
    72. 

  72. 

  73. 

  74. </FONT></TD>
    75. 

  75. </TR>
    76. 

  76. <TR>
    77. 

  77. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    78. 

  78.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    79. 

  79. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    80. 

  80. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    81. 

  81. </TR>
    82. 

  82. </TABLE>
    83. 

  83. <A NAME="skip-navbar_top"></A>
    84. 

  84. <!-- ========= END OF TOP NAVBAR ========= -->
    85. 

  85. 

  86. <HR>
    87. 

  87. <!-- ======== START OF CLASS DATA ======== -->
    88. 

  88. <H2>
    89. 

  89. <FONT SIZE="-1">
    90. 

  90. org.apache.commons.io</FONT>
    91. 

  91. <BR>
    92. 

  92. Class FileCleaner</H2>
    93. 

  93. <PRE>
    94. 

  94. <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
    95. 

  95.   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.io.FileCleaner</B>
    96. 

  96. </PRE>
    97. 

  97. <HR>
    98. 

  98. <B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io"><CODE>FileCleaningTracker</CODE></A></I>
    99. 

  99. <P>
    100. 

  100. <DL>
    101. 

  101. <DT><PRE><FONT SIZE="-1"><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
    102. 

  102. </FONT>public class <B>FileCleaner</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
    103. 

  103. </PRE>
    104. 

  104. 

  105. <P>
    106. 

  106. Keeps track of files awaiting deletion, and deletes them when an associated
    107. 

  107.  marker object is reclaimed by the garbage collector.
    108. 

  108.  <p>
    109. 

  109.  This utility creates a background thread to handle file deletion.
    110. 

  110.  Each file to be deleted is registered with a handler object.
    111. 

  111.  When the handler object is garbage collected, the file is deleted.
    112. 

  112.  <p>
    113. 

  113.  In an environment with multiple class loaders (a servlet container, for
    114. 

  114.  example), you should consider stopping the background thread if it is no
    115. 

  115.  longer needed. This is done by invoking the method
    116. 

  116.  <A HREF="../../../../org/apache/commons/io/FileCleaner.html#exitWhenFinished()"><CODE>exitWhenFinished()</CODE></A>, typically in
    117. 

  117.  <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletContextListener.html?is-external=true#contextDestroyed" title="class or interface in javax.servlet"><CODE>ServletContextListener</CODE></A> or similar.
    118. 

  118. <P>
    119. 

  119. 

  120. <P>
    121. 

  121. <DL>
    122. 

  122. <DT><B>Version:</B></DT>
    123. 

  123.   <DD>$Id: FileCleaner.java 723969 2008-12-06 11:00:40Z sebb $</DD>
    124. 

  124. <DT><B>Author:</B></DT>
    125. 

  125.   <DD>Noel Bergman, Martin Cooper</DD>
    126. 

  126. </DL>
    127. 

  127. <HR>
    128. 

  128. 

  129. <P>
    130. 

  130. <!-- =========== FIELD SUMMARY =========== -->
    131. 

  131. 

  132. <A NAME="field_summary"><!-- --></A>
    133. 

  133. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    134. 

  134. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    135. 

  135. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    136. 

  136. <B>Field Summary</B></FONT></TH>
    137. 

  137. </TR>
    138. 

  138. <TR BGCOLOR="white" CLASS="TableRowColor">
    139. 

  139. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    140. 

  140. <CODE>(package private) static&nbsp;<A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io">FileCleaningTracker</A></CODE></FONT></TD>
    141. 

  141. <TD><CODE><B><A HREF="../../../../org/apache/commons/io/FileCleaner.html#theInstance">theInstance</A></B></CODE>
    142. 

  142. 

  143. <BR>
    144. 

  144. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;The instance to use for the deprecated, static methods.</TD>
    145. 

  145. </TR>
    146. 

  146. </TABLE>
    147. 

  147. &nbsp;
    148. 

  148. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    149. 

  149. 

  150. <A NAME="constructor_summary"><!-- --></A>
    151. 

  151. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    152. 

  152. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    153. 

  153. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    154. 

  154. <B>Constructor Summary</B></FONT></TH>
    155. 

  155. </TR>
    156. 

  156. <TR BGCOLOR="white" CLASS="TableRowColor">
    157. 

  157. <TD><CODE><B><A HREF="../../../../org/apache/commons/io/FileCleaner.html#FileCleaner()">FileCleaner</A></B>()</CODE>
    158. 

  158. 

  159. <BR>
    160. 

  160. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;&nbsp;</TD>
    161. 

  161. </TR>
    162. 

  162. </TABLE>
    163. 

  163. &nbsp;
    164. 

  164. <!-- ========== METHOD SUMMARY =========== -->
    165. 

  165. 

  166. <A NAME="method_summary"><!-- --></A>
    167. 

  167. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    168. 

  168. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    169. 

  169. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    170. 

  170. <B>Method Summary</B></FONT></TH>
    171. 

  171. </TR>
    172. 

  172. <TR BGCOLOR="white" CLASS="TableRowColor">
    173. 

  173. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    174. 

  174. <CODE>static&nbsp;void</CODE></FONT></TD>
    175. 

  175. <TD><CODE><B><A HREF="../../../../org/apache/commons/io/FileCleaner.html#exitWhenFinished()">exitWhenFinished</A></B>()</CODE>
    176. 

  176. 

  177. <BR>
    178. 

  178. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html#exitWhenFinished()"><CODE>FileCleaningTracker.exitWhenFinished()</CODE></A>.</I></TD>
    179. 

  179. </TR>
    180. 

  180. <TR BGCOLOR="white" CLASS="TableRowColor">
    181. 

  181. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    182. 

  182. <CODE>static&nbsp;<A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io">FileCleaningTracker</A></CODE></FONT></TD>
    183. 

  183. <TD><CODE><B><A HREF="../../../../org/apache/commons/io/FileCleaner.html#getInstance()">getInstance</A></B>()</CODE>
    184. 

  184. 

  185. <BR>
    186. 

  186. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Returns the singleton instance, which is used by the deprecated, static methods.</TD>
    187. 

  187. </TR>
    188. 

  188. <TR BGCOLOR="white" CLASS="TableRowColor">
    189. 

  189. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    190. 

  190. <CODE>static&nbsp;int</CODE></FONT></TD>
    191. 

  191. <TD><CODE><B><A HREF="../../../../org/apache/commons/io/FileCleaner.html#getTrackCount()">getTrackCount</A></B>()</CODE>
    192. 

  192. 

  193. <BR>
    194. 

  194. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html#getTrackCount()"><CODE>FileCleaningTracker.getTrackCount()</CODE></A>.</I></TD>
    195. 

  195. </TR>
    196. 

  196. <TR BGCOLOR="white" CLASS="TableRowColor">
    197. 

  197. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    198. 

  198. <CODE>static&nbsp;void</CODE></FONT></TD>
    199. 

  199. <TD><CODE><B><A HREF="../../../../org/apache/commons/io/FileCleaner.html#track(java.io.File, java.lang.Object)">track</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;file,
    200. 

  200.       <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;marker)</CODE>
    201. 

  201. 

  202. <BR>
    203. 

  203. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html#track(java.io.File, java.lang.Object)"><CODE>FileCleaningTracker.track(File, Object)</CODE></A>.</I></TD>
    204. 

  204. </TR>
    205. 

  205. <TR BGCOLOR="white" CLASS="TableRowColor">
    206. 

  206. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    207. 

  207. <CODE>static&nbsp;void</CODE></FONT></TD>
    208. 

  208. <TD><CODE><B><A HREF="../../../../org/apache/commons/io/FileCleaner.html#track(java.io.File, java.lang.Object, org.apache.commons.io.FileDeleteStrategy)">track</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;file,
    209. 

  209.       <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;marker,
    210. 

  210.       <A HREF="../../../../org/apache/commons/io/FileDeleteStrategy.html" title="class in org.apache.commons.io">FileDeleteStrategy</A>&nbsp;deleteStrategy)</CODE>
    211. 

  211. 

  212. <BR>
    213. 

  213. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html#track(java.io.File, java.lang.Object, org.apache.commons.io.FileDeleteStrategy)"><CODE>FileCleaningTracker.track(File, Object, FileDeleteStrategy)</CODE></A>.</I></TD>
    214. 

  214. </TR>
    215. 

  215. <TR BGCOLOR="white" CLASS="TableRowColor">
    216. 

  216. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    217. 

  217. <CODE>static&nbsp;void</CODE></FONT></TD>
    218. 

  218. <TD><CODE><B><A HREF="../../../../org/apache/commons/io/FileCleaner.html#track(java.lang.String, java.lang.Object)">track</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;path,
    219. 

  219.       <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;marker)</CODE>
    220. 

  220. 

  221. <BR>
    222. 

  222. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html#track(java.lang.String, java.lang.Object)"><CODE>FileCleaningTracker.track(String, Object)</CODE></A>.</I></TD>
    223. 

  223. </TR>
    224. 

  224. <TR BGCOLOR="white" CLASS="TableRowColor">
    225. 

  225. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    226. 

  226. <CODE>static&nbsp;void</CODE></FONT></TD>
    227. 

  227. <TD><CODE><B><A HREF="../../../../org/apache/commons/io/FileCleaner.html#track(java.lang.String, java.lang.Object, org.apache.commons.io.FileDeleteStrategy)">track</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;path,
    228. 

  228.       <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;marker,
    229. 

  229.       <A HREF="../../../../org/apache/commons/io/FileDeleteStrategy.html" title="class in org.apache.commons.io">FileDeleteStrategy</A>&nbsp;deleteStrategy)</CODE>
    230. 

  230. 

  231. <BR>
    232. 

  232. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html#track(java.lang.String, java.lang.Object, org.apache.commons.io.FileDeleteStrategy)"><CODE>FileCleaningTracker.track(String, Object, FileDeleteStrategy)</CODE></A>.</I></TD>
    233. 

  233. </TR>
    234. 

  234. </TABLE>
    235. 

  235. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
    236. 

  236. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    237. 

  237. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    238. 

  238. <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
    239. 

  239. </TR>
    240. 

  240. <TR BGCOLOR="white" CLASS="TableRowColor">
    241. 

  241. <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
    242. 

  242. </TR>
    243. 

  243. </TABLE>
    244. 

  244. &nbsp;
    245. 

  245. <P>
    246. 

  246. 

  247. <!-- ============ FIELD DETAIL =========== -->
    248. 

  248. 

  249. <A NAME="field_detail"><!-- --></A>
    250. 

  250. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    251. 

  251. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    252. 

  252. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    253. 

  253. <B>Field Detail</B></FONT></TH>
    254. 

  254. </TR>
    255. 

  255. </TABLE>
    256. 

  256. 

  257. <A NAME="theInstance"><!-- --></A><H3>
    258. 

  258. theInstance</H3>
    259. 

  259. <PRE>
    260. 

  260. static final <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io">FileCleaningTracker</A> <B>theInstance</B></PRE>
    261. 

  261. <DL>
    262. 

  262. <DD><B>Deprecated.</B>&nbsp;<DD>The instance to use for the deprecated, static methods.
    263. 

  263. <P>
    264. 

  264. <DL>
    265. 

  265. </DL>
    266. 

  266. </DL>
    267. 

  267. 

  268. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    269. 

  269. 

  270. <A NAME="constructor_detail"><!-- --></A>
    271. 

  271. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    272. 

  272. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    273. 

  273. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    274. 

  274. <B>Constructor Detail</B></FONT></TH>
    275. 

  275. </TR>
    276. 

  276. </TABLE>
    277. 

  277. 

  278. <A NAME="FileCleaner()"><!-- --></A><H3>
    279. 

  279. FileCleaner</H3>
    280. 

  280. <PRE>
    281. 

  281. public <B>FileCleaner</B>()</PRE>
    282. 

  282. <DL>
    283. 

  283. <DD><B>Deprecated.</B>&nbsp;</DL>
    284. 

  284. 

  285. <!-- ============ METHOD DETAIL ========== -->
    286. 

  286. 

  287. <A NAME="method_detail"><!-- --></A>
    288. 

  288. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    289. 

  289. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    290. 

  290. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    291. 

  291. <B>Method Detail</B></FONT></TH>
    292. 

  292. </TR>
    293. 

  293. </TABLE>
    294. 

  294. 

  295. <A NAME="track(java.io.File, java.lang.Object)"><!-- --></A><H3>
    296. 

  296. track</H3>
    297. 

  297. <PRE>
    298. 

  298. <FONT SIZE="-1"><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
    299. 

  299. </FONT>public static void <B>track</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;file,
    300. 

  300.                                     <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;marker)</PRE>
    301. 

  301. <DL>
    302. 

  302. <DD><B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html#track(java.io.File, java.lang.Object)"><CODE>FileCleaningTracker.track(File, Object)</CODE></A>.</I>
    303. 

  303. <P>
    304. 

  304. <DD>Track the specified file, using the provided marker, deleting the file
    305. 

  305.  when the marker instance is garbage collected.
    306. 

  306.  The <A HREF="../../../../org/apache/commons/io/FileDeleteStrategy.html#NORMAL"><CODE>normal</CODE></A> deletion strategy will be used.
    307. 

  307. <P>
    308. 

  308. <DD><DL>
    309. 

  309. <DT><B>Parameters:</B><DD><CODE>file</CODE> - the file to be tracked, not null<DD><CODE>marker</CODE> - the marker object used to track the file, not null
    310. 

  310. <DT><B>Throws:</B>
    311. 

  311. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if the file is null</DL>
    312. 

  312. </DD>
    313. 

  313. </DL>
    314. 

  314. <HR>
    315. 

  315. 

  316. <A NAME="track(java.io.File, java.lang.Object, org.apache.commons.io.FileDeleteStrategy)"><!-- --></A><H3>
    317. 

  317. track</H3>
    318. 

  318. <PRE>
    319. 

  319. <FONT SIZE="-1"><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
    320. 

  320. </FONT>public static void <B>track</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;file,
    321. 

  321.                                     <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;marker,
    322. 

  322.                                     <A HREF="../../../../org/apache/commons/io/FileDeleteStrategy.html" title="class in org.apache.commons.io">FileDeleteStrategy</A>&nbsp;deleteStrategy)</PRE>
    323. 

  323. <DL>
    324. 

  324. <DD><B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html#track(java.io.File, java.lang.Object, org.apache.commons.io.FileDeleteStrategy)"><CODE>FileCleaningTracker.track(File, Object, FileDeleteStrategy)</CODE></A>.</I>
    325. 

  325. <P>
    326. 

  326. <DD>Track the specified file, using the provided marker, deleting the file
    327. 

  327.  when the marker instance is garbage collected.
    328. 

  328.  The speified deletion strategy is used.
    329. 

  329. <P>
    330. 

  330. <DD><DL>
    331. 

  331. <DT><B>Parameters:</B><DD><CODE>file</CODE> - the file to be tracked, not null<DD><CODE>marker</CODE> - the marker object used to track the file, not null<DD><CODE>deleteStrategy</CODE> - the strategy to delete the file, null means normal
    332. 

  332. <DT><B>Throws:</B>
    333. 

  333. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if the file is null</DL>
    334. 

  334. </DD>
    335. 

  335. </DL>
    336. 

  336. <HR>
    337. 

  337. 

  338. <A NAME="track(java.lang.String, java.lang.Object)"><!-- --></A><H3>
    339. 

  339. track</H3>
    340. 

  340. <PRE>
    341. 

  341. <FONT SIZE="-1"><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
    342. 

  342. </FONT>public static void <B>track</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;path,
    343. 

  343.                                     <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;marker)</PRE>
    344. 

  344. <DL>
    345. 

  345. <DD><B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html#track(java.lang.String, java.lang.Object)"><CODE>FileCleaningTracker.track(String, Object)</CODE></A>.</I>
    346. 

  346. <P>
    347. 

  347. <DD>Track the specified file, using the provided marker, deleting the file
    348. 

  348.  when the marker instance is garbage collected.
    349. 

  349.  The <A HREF="../../../../org/apache/commons/io/FileDeleteStrategy.html#NORMAL"><CODE>normal</CODE></A> deletion strategy will be used.
    350. 

  350. <P>
    351. 

  351. <DD><DL>
    352. 

  352. <DT><B>Parameters:</B><DD><CODE>path</CODE> - the full path to the file to be tracked, not null<DD><CODE>marker</CODE> - the marker object used to track the file, not null
    353. 

  353. <DT><B>Throws:</B>
    354. 

  354. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if the path is null</DL>
    355. 

  355. </DD>
    356. 

  356. </DL>
    357. 

  357. <HR>
    358. 

  358. 

  359. <A NAME="track(java.lang.String, java.lang.Object, org.apache.commons.io.FileDeleteStrategy)"><!-- --></A><H3>
    360. 

  360. track</H3>
    361. 

  361. <PRE>
    362. 

  362. <FONT SIZE="-1"><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
    363. 

  363. </FONT>public static void <B>track</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;path,
    364. 

  364.                                     <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;marker,
    365. 

  365.                                     <A HREF="../../../../org/apache/commons/io/FileDeleteStrategy.html" title="class in org.apache.commons.io">FileDeleteStrategy</A>&nbsp;deleteStrategy)</PRE>
    366. 

  366. <DL>
    367. 

  367. <DD><B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html#track(java.lang.String, java.lang.Object, org.apache.commons.io.FileDeleteStrategy)"><CODE>FileCleaningTracker.track(String, Object, FileDeleteStrategy)</CODE></A>.</I>
    368. 

  368. <P>
    369. 

  369. <DD>Track the specified file, using the provided marker, deleting the file
    370. 

  370.  when the marker instance is garbage collected.
    371. 

  371.  The speified deletion strategy is used.
    372. 

  372. <P>
    373. 

  373. <DD><DL>
    374. 

  374. <DT><B>Parameters:</B><DD><CODE>path</CODE> - the full path to the file to be tracked, not null<DD><CODE>marker</CODE> - the marker object used to track the file, not null<DD><CODE>deleteStrategy</CODE> - the strategy to delete the file, null means normal
    375. 

  375. <DT><B>Throws:</B>
    376. 

  376. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if the path is null</DL>
    377. 

  377. </DD>
    378. 

  378. </DL>
    379. 

  379. <HR>
    380. 

  380. 

  381. <A NAME="getTrackCount()"><!-- --></A><H3>
    382. 

  382. getTrackCount</H3>
    383. 

  383. <PRE>
    384. 

  384. <FONT SIZE="-1"><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
    385. 

  385. </FONT>public static int <B>getTrackCount</B>()</PRE>
    386. 

  386. <DL>
    387. 

  387. <DD><B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html#getTrackCount()"><CODE>FileCleaningTracker.getTrackCount()</CODE></A>.</I>
    388. 

  388. <P>
    389. 

  389. <DD>Retrieve the number of files currently being tracked, and therefore
    390. 

  390.  awaiting deletion.
    391. 

  391. <P>
    392. 

  392. <DD><DL>
    393. 

  393. 

  394. <DT><B>Returns:</B><DD>the number of files being tracked</DL>
    395. 

  395. </DD>
    396. 

  396. </DL>
    397. 

  397. <HR>
    398. 

  398. 

  399. <A NAME="exitWhenFinished()"><!-- --></A><H3>
    400. 

  400. exitWhenFinished</H3>
    401. 

  401. <PRE>
    402. 

  402. <FONT SIZE="-1"><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
    403. 

  403. </FONT>public static void <B>exitWhenFinished</B>()</PRE>
    404. 

  404. <DL>
    405. 

  405. <DD><B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html#exitWhenFinished()"><CODE>FileCleaningTracker.exitWhenFinished()</CODE></A>.</I>
    406. 

  406. <P>
    407. 

  407. <DD>Call this method to cause the file cleaner thread to terminate when
    408. 

  408.  there are no more objects being tracked for deletion.
    409. 

  409.  <p>
    410. 

  410.  In a simple environment, you don't need this method as the file cleaner
    411. 

  411.  thread will simply exit when the JVM exits. In a more complex environment,
    412. 

  412.  with multiple class loaders (such as an application server), you should be
    413. 

  413.  aware that the file cleaner thread will continue running even if the class
    414. 

  414.  loader it was started from terminates. This can consitute a memory leak.
    415. 

  415.  <p>
    416. 

  416.  For example, suppose that you have developed a web application, which
    417. 

  417.  contains the commons-io jar file in your WEB-INF/lib directory. In other
    418. 

  418.  words, the FileCleaner class is loaded through the class loader of your
    419. 

  419.  web application. If the web application is terminated, but the servlet
    420. 

  420.  container is still running, then the file cleaner thread will still exist,
    421. 

  421.  posing a memory leak.
    422. 

  422.  <p>
    423. 

  423.  This method allows the thread to be terminated. Simply call this method
    424. 

  424.  in the resource cleanup code, such as <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletContextListener.html?is-external=true#contextDestroyed" title="class or interface in javax.servlet"><CODE>ServletContextListener</CODE></A>.
    425. 

  425.  One called, no new objects can be tracked by the file cleaner.
    426. 

  426. <P>
    427. 

  427. <DD><DL>
    428. 

  428. </DL>
    429. 

  429. </DD>
    430. 

  430. </DL>
    431. 

  431. <HR>
    432. 

  432. 

  433. <A NAME="getInstance()"><!-- --></A><H3>
    434. 

  434. getInstance</H3>
    435. 

  435. <PRE>
    436. 

  436. public static <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io">FileCleaningTracker</A> <B>getInstance</B>()</PRE>
    437. 

  437. <DL>
    438. 

  438. <DD><B>Deprecated.</B>&nbsp;<DD>Returns the singleton instance, which is used by the deprecated, static methods.
    439. 

  439.  This is mainly useful for code, which wants to support the new
    440. 

  440.  <A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io"><CODE>FileCleaningTracker</CODE></A> class while maintain compatibility with the
    441. 

  441.  deprecated <A HREF="../../../../org/apache/commons/io/FileCleaner.html" title="class in org.apache.commons.io"><CODE>FileCleaner</CODE></A>.
    442. 

  442. <P>
    443. 

  443. <DD><DL>
    444. 

  444. 

  445. <DT><B>Returns:</B><DD>the singleton instance</DL>
    446. 

  446. </DD>
    447. 

  447. </DL>
    448. 

  448. <!-- ========= END OF CLASS DATA ========= -->
    449. 

  449. <HR>
    450. 

  450. 

  451. 

  452. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    453. 

  453. <A NAME="navbar_bottom"><!-- --></A>
    454. 

  454. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    455. 

  455. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    456. 

  456. <TR>
    457. 

  457. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    458. 

  458. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    459. 

  459. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    460. 

  460.   <TR ALIGN="center" VALIGN="top">
    461. 

  461.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    462. 

  462.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    463. 

  463.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    464. 

  464.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    465. 

  465.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    466. 

  466.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    467. 

  467.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    468. 

  468.   </TR>
    469. 

  469. </TABLE>
    470. 

  470. </TD>
    471. 

  471. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    472. 

  472. </EM>
    473. 

  473. </TD>
    474. 

  474. </TR>
    475. 

  475. 

  476. <TR>
    477. 

  477. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    478. 

  478. &nbsp;<A HREF="../../../../org/apache/commons/io/EndianUtils.html" title="class in org.apache.commons.io"><B>PREV CLASS</B></A>&nbsp;
    479. 

  479. &nbsp;<A HREF="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io"><B>NEXT CLASS</B></A></FONT></TD>
    480. 

  480. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    481. 

  481.   <A HREF="../../../../index.html?org/apache/commons/io/FileCleaner.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    482. 

  482. &nbsp;<A HREF="FileCleaner.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    483. 

  483. &nbsp;<SCRIPT type="text/javascript">
    484. 

  484.   <!--
    485. 

  485.   if(window==top) {
    486. 

  486.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    487. 

  487.   }
    488. 

  488.   //-->
    489. 

  489. </SCRIPT>
    490. 

  490. <NOSCRIPT>
    491. 

  491.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    492. 

  492. </NOSCRIPT>
    493. 

  493. 

  494. 

  495. </FONT></TD>
    496. 

  496. </TR>
    497. 

  497. <TR>
    498. 

  498. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    499. 

  499.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    500. 

  500. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    501. 

  501. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    502. 

  502. </TR>
    503. 

  503. </TABLE>
    504. 

  504. <A NAME="skip-navbar_bottom"></A>
    505. 

  505. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    506. 

  506. 

  507. <HR>
    508. 

  508. Copyright (c) 2002-2010  Apache Software Foundation
    509. 

  509. </BODY>
    510. 

  510. </HTML>
    511.