FileCleaner.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="de">
  4. <head>
  5. <!-- Generated by javadoc -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  7. <title>FileCleaner (Apache Commons IO 2.6 API)</title>
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="FileCleaner (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":41,"i1":41,"i2":41,"i3":41,"i4":41,"i5":41,"i6":41};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/FileCleaner.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../index-all.html">Index</a></li>
  47. <li><a href="../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../org/apache/commons/io/EndianUtils.html" title="class in org.apache.commons.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/apache/commons/io/FileCleaner.html" target="_top">Frames</a></li>
  57. <li><a href="FileCleaner.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.apache.commons.io</div>
  96. <h2 title="Class FileCleaner" class="title">Class FileCleaner</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>org.apache.commons.io.FileCleaner</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <hr>
  111. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  112. <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io"><code>FileCleaningTracker</code></a></span></div>
  113. </div>
  114. <br>
  115. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
  116. public class <span class="typeNameLabel">FileCleaner</span>
  117. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
  118. <div class="block">Keeps track of files awaiting deletion, and deletes them when an associated
  119. marker object is reclaimed by the garbage collector.
  120. <p>
  121. This utility creates a background thread to handle file deletion.
  122. Each file to be deleted is registered with a handler object.
  123. When the handler object is garbage collected, the file is deleted.
  124. <p>
  125. In an environment with multiple class loaders (a servlet container, for
  126. example), you should consider stopping the background thread if it is no
  127. longer needed. This is done by invoking the method
  128. <a href="../../../../org/apache/commons/io/FileCleaner.html#exitWhenFinished--"><code>exitWhenFinished()</code></a>, typically in
  129. <code>javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent)</code> or similar.</div>
  130. </li>
  131. </ul>
  132. </div>
  133. <div class="summary">
  134. <ul class="blockList">
  135. <li class="blockList">
  136. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  137. <ul class="blockList">
  138. <li class="blockList"><a name="constructor.summary">
  139. <!-- -->
  140. </a>
  141. <h3>Constructor Summary</h3>
  142. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  143. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  144. <tr>
  145. <th class="colOne" scope="col">Constructor and Description</th>
  146. </tr>
  147. <tr class="altColor">
  148. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/FileCleaner.html#FileCleaner--">FileCleaner</a></span>()</code>
  149. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  150. &nbsp;</td>
  151. </tr>
  152. </table>
  153. </li>
  154. </ul>
  155. <!-- ========== METHOD SUMMARY =========== -->
  156. <ul class="blockList">
  157. <li class="blockList"><a name="method.summary">
  158. <!-- -->
  159. </a>
  160. <h3>Method Summary</h3>
  161. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  162. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  163. <tr>
  164. <th class="colFirst" scope="col">Modifier and Type</th>
  165. <th class="colLast" scope="col">Method and Description</th>
  166. </tr>
  167. <tr id="i0" class="altColor">
  168. <td class="colFirst"><code>static void</code></td>
  169. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/FileCleaner.html#exitWhenFinished--">exitWhenFinished</a></span>()</code>
  170. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  171. <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/commons/io/FileCleaningTracker.html#exitWhenFinished--"><code>FileCleaningTracker.exitWhenFinished()</code></a>.</span></div>
  172. </div>
  173. </td>
  174. </tr>
  175. <tr id="i1" class="rowColor">
  176. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io">FileCleaningTracker</a></code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/FileCleaner.html#getInstance--">getInstance</a></span>()</code>
  178. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  179. <div class="block">Returns the singleton instance, which is used by the deprecated, static methods.</div>
  180. </td>
  181. </tr>
  182. <tr id="i2" class="altColor">
  183. <td class="colFirst"><code>static int</code></td>
  184. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/FileCleaner.html#getTrackCount--">getTrackCount</a></span>()</code>
  185. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  186. <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/commons/io/FileCleaningTracker.html#getTrackCount--"><code>FileCleaningTracker.getTrackCount()</code></a>.</span></div>
  187. </div>
  188. </td>
  189. </tr>
  190. <tr id="i3" class="rowColor">
  191. <td class="colFirst"><code>static void</code></td>
  192. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/FileCleaner.html#track-java.io.File-java.lang.Object-">track</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
  193. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;marker)</code>
  194. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  195. <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/commons/io/FileCleaningTracker.html#track-java.io.File-java.lang.Object-"><code>FileCleaningTracker.track(File, Object)</code></a>.</span></div>
  196. </div>
  197. </td>
  198. </tr>
  199. <tr id="i4" class="altColor">
  200. <td class="colFirst"><code>static void</code></td>
  201. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/FileCleaner.html#track-java.io.File-java.lang.Object-org.apache.commons.io.FileDeleteStrategy-">track</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
  202. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;marker,
  203. <a href="../../../../org/apache/commons/io/FileDeleteStrategy.html" title="class in org.apache.commons.io">FileDeleteStrategy</a>&nbsp;deleteStrategy)</code>
  204. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  205. <div class="block"><span class="deprecationComment">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>.</span></div>
  206. </div>
  207. </td>
  208. </tr>
  209. <tr id="i5" class="rowColor">
  210. <td class="colFirst"><code>static void</code></td>
  211. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/FileCleaner.html#track-java.lang.String-java.lang.Object-">track</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path,
  212. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;marker)</code>
  213. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  214. <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/commons/io/FileCleaningTracker.html#track-java.lang.String-java.lang.Object-"><code>FileCleaningTracker.track(String, Object)</code></a>.</span></div>
  215. </div>
  216. </td>
  217. </tr>
  218. <tr id="i6" class="altColor">
  219. <td class="colFirst"><code>static void</code></td>
  220. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/FileCleaner.html#track-java.lang.String-java.lang.Object-org.apache.commons.io.FileDeleteStrategy-">track</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path,
  221. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;marker,
  222. <a href="../../../../org/apache/commons/io/FileDeleteStrategy.html" title="class in org.apache.commons.io">FileDeleteStrategy</a>&nbsp;deleteStrategy)</code>
  223. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  224. <div class="block"><span class="deprecationComment">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>.</span></div>
  225. </div>
  226. </td>
  227. </tr>
  228. </table>
  229. <ul class="blockList">
  230. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  231. <!-- -->
  232. </a>
  233. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
  234. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/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://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
  235. </ul>
  236. </li>
  237. </ul>
  238. </li>
  239. </ul>
  240. </div>
  241. <div class="details">
  242. <ul class="blockList">
  243. <li class="blockList">
  244. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  245. <ul class="blockList">
  246. <li class="blockList"><a name="constructor.detail">
  247. <!-- -->
  248. </a>
  249. <h3>Constructor Detail</h3>
  250. <a name="FileCleaner--">
  251. <!-- -->
  252. </a>
  253. <ul class="blockListLast">
  254. <li class="blockList">
  255. <h4>FileCleaner</h4>
  256. <pre>public&nbsp;FileCleaner()</pre>
  257. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  258. </li>
  259. </ul>
  260. </li>
  261. </ul>
  262. <!-- ============ METHOD DETAIL ========== -->
  263. <ul class="blockList">
  264. <li class="blockList"><a name="method.detail">
  265. <!-- -->
  266. </a>
  267. <h3>Method Detail</h3>
  268. <a name="track-java.io.File-java.lang.Object-">
  269. <!-- -->
  270. </a>
  271. <ul class="blockList">
  272. <li class="blockList">
  273. <h4>track</h4>
  274. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
  275. public static&nbsp;void&nbsp;track(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
  276. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;marker)</pre>
  277. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../org/apache/commons/io/FileCleaningTracker.html#track-java.io.File-java.lang.Object-"><code>FileCleaningTracker.track(File, Object)</code></a>.</span></div>
  278. <div class="block">Track the specified file, using the provided marker, deleting the file
  279. when the marker instance is garbage collected.
  280. The <a href="../../../../org/apache/commons/io/FileDeleteStrategy.html#NORMAL"><code>normal</code></a> deletion strategy will be used.</div>
  281. <dl>
  282. <dt><span class="paramLabel">Parameters:</span></dt>
  283. <dd><code>file</code> - the file to be tracked, not null</dd>
  284. <dd><code>marker</code> - the marker object used to track the file, not null</dd>
  285. <dt><span class="throwsLabel">Throws:</span></dt>
  286. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the file is null</dd>
  287. </dl>
  288. </li>
  289. </ul>
  290. <a name="track-java.io.File-java.lang.Object-org.apache.commons.io.FileDeleteStrategy-">
  291. <!-- -->
  292. </a>
  293. <ul class="blockList">
  294. <li class="blockList">
  295. <h4>track</h4>
  296. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
  297. public static&nbsp;void&nbsp;track(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
  298. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;marker,
  299. <a href="../../../../org/apache/commons/io/FileDeleteStrategy.html" title="class in org.apache.commons.io">FileDeleteStrategy</a>&nbsp;deleteStrategy)</pre>
  300. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">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>.</span></div>
  301. <div class="block">Track the specified file, using the provided marker, deleting the file
  302. when the marker instance is garbage collected.
  303. The specified deletion strategy is used.</div>
  304. <dl>
  305. <dt><span class="paramLabel">Parameters:</span></dt>
  306. <dd><code>file</code> - the file to be tracked, not null</dd>
  307. <dd><code>marker</code> - the marker object used to track the file, not null</dd>
  308. <dd><code>deleteStrategy</code> - the strategy to delete the file, null means normal</dd>
  309. <dt><span class="throwsLabel">Throws:</span></dt>
  310. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the file is null</dd>
  311. </dl>
  312. </li>
  313. </ul>
  314. <a name="track-java.lang.String-java.lang.Object-">
  315. <!-- -->
  316. </a>
  317. <ul class="blockList">
  318. <li class="blockList">
  319. <h4>track</h4>
  320. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
  321. public static&nbsp;void&nbsp;track(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path,
  322. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;marker)</pre>
  323. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../org/apache/commons/io/FileCleaningTracker.html#track-java.lang.String-java.lang.Object-"><code>FileCleaningTracker.track(String, Object)</code></a>.</span></div>
  324. <div class="block">Track the specified file, using the provided marker, deleting the file
  325. when the marker instance is garbage collected.
  326. The <a href="../../../../org/apache/commons/io/FileDeleteStrategy.html#NORMAL"><code>normal</code></a> deletion strategy will be used.</div>
  327. <dl>
  328. <dt><span class="paramLabel">Parameters:</span></dt>
  329. <dd><code>path</code> - the full path to the file to be tracked, not null</dd>
  330. <dd><code>marker</code> - the marker object used to track the file, not null</dd>
  331. <dt><span class="throwsLabel">Throws:</span></dt>
  332. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the path is null</dd>
  333. </dl>
  334. </li>
  335. </ul>
  336. <a name="track-java.lang.String-java.lang.Object-org.apache.commons.io.FileDeleteStrategy-">
  337. <!-- -->
  338. </a>
  339. <ul class="blockList">
  340. <li class="blockList">
  341. <h4>track</h4>
  342. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
  343. public static&nbsp;void&nbsp;track(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path,
  344. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;marker,
  345. <a href="../../../../org/apache/commons/io/FileDeleteStrategy.html" title="class in org.apache.commons.io">FileDeleteStrategy</a>&nbsp;deleteStrategy)</pre>
  346. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">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>.</span></div>
  347. <div class="block">Track the specified file, using the provided marker, deleting the file
  348. when the marker instance is garbage collected.
  349. The specified deletion strategy is used.</div>
  350. <dl>
  351. <dt><span class="paramLabel">Parameters:</span></dt>
  352. <dd><code>path</code> - the full path to the file to be tracked, not null</dd>
  353. <dd><code>marker</code> - the marker object used to track the file, not null</dd>
  354. <dd><code>deleteStrategy</code> - the strategy to delete the file, null means normal</dd>
  355. <dt><span class="throwsLabel">Throws:</span></dt>
  356. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the path is null</dd>
  357. </dl>
  358. </li>
  359. </ul>
  360. <a name="getTrackCount--">
  361. <!-- -->
  362. </a>
  363. <ul class="blockList">
  364. <li class="blockList">
  365. <h4>getTrackCount</h4>
  366. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
  367. public static&nbsp;int&nbsp;getTrackCount()</pre>
  368. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../org/apache/commons/io/FileCleaningTracker.html#getTrackCount--"><code>FileCleaningTracker.getTrackCount()</code></a>.</span></div>
  369. <div class="block">Retrieve the number of files currently being tracked, and therefore
  370. awaiting deletion.</div>
  371. <dl>
  372. <dt><span class="returnLabel">Returns:</span></dt>
  373. <dd>the number of files being tracked</dd>
  374. </dl>
  375. </li>
  376. </ul>
  377. <a name="exitWhenFinished--">
  378. <!-- -->
  379. </a>
  380. <ul class="blockList">
  381. <li class="blockList">
  382. <h4>exitWhenFinished</h4>
  383. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
  384. public static&nbsp;void&nbsp;exitWhenFinished()</pre>
  385. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../org/apache/commons/io/FileCleaningTracker.html#exitWhenFinished--"><code>FileCleaningTracker.exitWhenFinished()</code></a>.</span></div>
  386. <div class="block">Call this method to cause the file cleaner thread to terminate when
  387. there are no more objects being tracked for deletion.
  388. <p>
  389. In a simple environment, you don't need this method as the file cleaner
  390. thread will simply exit when the JVM exits. In a more complex environment,
  391. with multiple class loaders (such as an application server), you should be
  392. aware that the file cleaner thread will continue running even if the class
  393. loader it was started from terminates. This can constitute a memory leak.
  394. <p>
  395. For example, suppose that you have developed a web application, which
  396. contains the commons-io jar file in your WEB-INF/lib directory. In other
  397. words, the FileCleaner class is loaded through the class loader of your
  398. web application. If the web application is terminated, but the servlet
  399. container is still running, then the file cleaner thread will still exist,
  400. posing a memory leak.
  401. <p>
  402. This method allows the thread to be terminated. Simply call this method
  403. in the resource cleanup code, such as
  404. <code>javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent)</code>.
  405. One called, no new objects can be tracked by the file cleaner.</div>
  406. </li>
  407. </ul>
  408. <a name="getInstance--">
  409. <!-- -->
  410. </a>
  411. <ul class="blockListLast">
  412. <li class="blockList">
  413. <h4>getInstance</h4>
  414. <pre>public static&nbsp;<a href="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io">FileCleaningTracker</a>&nbsp;getInstance()</pre>
  415. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  416. <div class="block">Returns the singleton instance, which is used by the deprecated, static methods.
  417. This is mainly useful for code, which wants to support the new
  418. <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
  419. deprecated <a href="../../../../org/apache/commons/io/FileCleaner.html" title="class in org.apache.commons.io"><code>FileCleaner</code></a>.</div>
  420. <dl>
  421. <dt><span class="returnLabel">Returns:</span></dt>
  422. <dd>the singleton instance</dd>
  423. </dl>
  424. </li>
  425. </ul>
  426. </li>
  427. </ul>
  428. </li>
  429. </ul>
  430. </div>
  431. </div>
  432. <!-- ========= END OF CLASS DATA ========= -->
  433. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  434. <div class="bottomNav"><a name="navbar.bottom">
  435. <!-- -->
  436. </a>
  437. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  438. <a name="navbar.bottom.firstrow">
  439. <!-- -->
  440. </a>
  441. <ul class="navList" title="Navigation">
  442. <li><a href="../../../../overview-summary.html">Overview</a></li>
  443. <li><a href="package-summary.html">Package</a></li>
  444. <li class="navBarCell1Rev">Class</li>
  445. <li><a href="class-use/FileCleaner.html">Use</a></li>
  446. <li><a href="package-tree.html">Tree</a></li>
  447. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  448. <li><a href="../../../../index-all.html">Index</a></li>
  449. <li><a href="../../../../help-doc.html">Help</a></li>
  450. </ul>
  451. </div>
  452. <div class="subNav">
  453. <ul class="navList">
  454. <li><a href="../../../../org/apache/commons/io/EndianUtils.html" title="class in org.apache.commons.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  455. <li><a href="../../../../org/apache/commons/io/FileCleaningTracker.html" title="class in org.apache.commons.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  456. </ul>
  457. <ul class="navList">
  458. <li><a href="../../../../index.html?org/apache/commons/io/FileCleaner.html" target="_top">Frames</a></li>
  459. <li><a href="FileCleaner.html" target="_top">No&nbsp;Frames</a></li>
  460. </ul>
  461. <ul class="navList" id="allclasses_navbar_bottom">
  462. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  463. </ul>
  464. <div>
  465. <script type="text/javascript"><!--
  466. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  467. if(window==top) {
  468. allClassesLink.style.display = "block";
  469. }
  470. else {
  471. allClassesLink.style.display = "none";
  472. }
  473. //-->
  474. </script>
  475. </div>
  476. <div>
  477. <ul class="subNavList">
  478. <li>Summary:&nbsp;</li>
  479. <li>Nested&nbsp;|&nbsp;</li>
  480. <li>Field&nbsp;|&nbsp;</li>
  481. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  482. <li><a href="#method.summary">Method</a></li>
  483. </ul>
  484. <ul class="subNavList">
  485. <li>Detail:&nbsp;</li>
  486. <li>Field&nbsp;|&nbsp;</li>
  487. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  488. <li><a href="#method.detail">Method</a></li>
  489. </ul>
  490. </div>
  491. <a name="skip.navbar.bottom">
  492. <!-- -->
  493. </a></div>
  494. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  495. <p class="legalCopy"><small>Copyright &#169; 2002&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  496. </body>
  497. </html>