DirectoryWalker.CancelException.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376
  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>DirectoryWalker.CancelException (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="DirectoryWalker.CancelException (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/DirectoryWalker.CancelException.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/DirectoryWalker.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/EndianUtils.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/DirectoryWalker.CancelException.html" target="_top">Frames</a></li>
  57. <li><a href="DirectoryWalker.CancelException.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 DirectoryWalker.CancelException" class="title">Class DirectoryWalker.CancelException</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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
  107. <li>
  108. <ul class="inheritance">
  109. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">java.io.IOException</a></li>
  110. <li>
  111. <ul class="inheritance">
  112. <li>org.apache.commons.io.DirectoryWalker.CancelException</li>
  113. </ul>
  114. </li>
  115. </ul>
  116. </li>
  117. </ul>
  118. </li>
  119. </ul>
  120. </li>
  121. </ul>
  122. <div class="description">
  123. <ul class="blockList">
  124. <li class="blockList">
  125. <dl>
  126. <dt>All Implemented Interfaces:</dt>
  127. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
  128. </dl>
  129. <dl>
  130. <dt>Enclosing class:</dt>
  131. <dd><a href="../../../../org/apache/commons/io/DirectoryWalker.html" title="class in org.apache.commons.io">DirectoryWalker</a>&lt;<a href="../../../../org/apache/commons/io/DirectoryWalker.html" title="type parameter in DirectoryWalker">T</a>&gt;</dd>
  132. </dl>
  133. <hr>
  134. <br>
  135. <pre>public static class <span class="typeNameLabel">DirectoryWalker.CancelException</span>
  136. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  137. <div class="block">CancelException is thrown in DirectoryWalker to cancel the current
  138. processing.</div>
  139. <dl>
  140. <dt><span class="seeLabel">See Also:</span></dt>
  141. <dd><a href="../../../../serialized-form.html#org.apache.commons.io.DirectoryWalker.CancelException">Serialized Form</a></dd>
  142. </dl>
  143. </li>
  144. </ul>
  145. </div>
  146. <div class="summary">
  147. <ul class="blockList">
  148. <li class="blockList">
  149. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  150. <ul class="blockList">
  151. <li class="blockList"><a name="constructor.summary">
  152. <!-- -->
  153. </a>
  154. <h3>Constructor Summary</h3>
  155. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  156. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  157. <tr>
  158. <th class="colOne" scope="col">Constructor and Description</th>
  159. </tr>
  160. <tr class="altColor">
  161. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/DirectoryWalker.CancelException.html#CancelException-java.io.File-int-">CancelException</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,
  162. int&nbsp;depth)</code>
  163. <div class="block">Constructs a <code>CancelException</code> with
  164. the file and depth when cancellation occurred.</div>
  165. </td>
  166. </tr>
  167. <tr class="rowColor">
  168. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/DirectoryWalker.CancelException.html#CancelException-java.lang.String-java.io.File-int-">CancelException</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;message,
  169. <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,
  170. int&nbsp;depth)</code>
  171. <div class="block">Constructs a <code>CancelException</code> with
  172. an appropriate message and the file and depth when
  173. cancellation occurred.</div>
  174. </td>
  175. </tr>
  176. </table>
  177. </li>
  178. </ul>
  179. <!-- ========== METHOD SUMMARY =========== -->
  180. <ul class="blockList">
  181. <li class="blockList"><a name="method.summary">
  182. <!-- -->
  183. </a>
  184. <h3>Method Summary</h3>
  185. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  186. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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></caption>
  187. <tr>
  188. <th class="colFirst" scope="col">Modifier and Type</th>
  189. <th class="colLast" scope="col">Method and Description</th>
  190. </tr>
  191. <tr id="i0" class="altColor">
  192. <td class="colFirst"><code>int</code></td>
  193. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/DirectoryWalker.CancelException.html#getDepth--">getDepth</a></span>()</code>
  194. <div class="block">Return the depth when the operation was cancelled.</div>
  195. </td>
  196. </tr>
  197. <tr id="i1" class="rowColor">
  198. <td class="colFirst"><code><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></code></td>
  199. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/DirectoryWalker.CancelException.html#getFile--">getFile</a></span>()</code>
  200. <div class="block">Return the file when the operation was cancelled.</div>
  201. </td>
  202. </tr>
  203. </table>
  204. <ul class="blockList">
  205. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
  206. <!-- -->
  207. </a>
  208. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
  209. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or interface in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li>
  210. </ul>
  211. <ul class="blockList">
  212. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  213. <!-- -->
  214. </a>
  215. <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>
  216. <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#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>
  217. </ul>
  218. </li>
  219. </ul>
  220. </li>
  221. </ul>
  222. </div>
  223. <div class="details">
  224. <ul class="blockList">
  225. <li class="blockList">
  226. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  227. <ul class="blockList">
  228. <li class="blockList"><a name="constructor.detail">
  229. <!-- -->
  230. </a>
  231. <h3>Constructor Detail</h3>
  232. <a name="CancelException-java.io.File-int-">
  233. <!-- -->
  234. </a>
  235. <ul class="blockList">
  236. <li class="blockList">
  237. <h4>CancelException</h4>
  238. <pre>public&nbsp;CancelException(<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,
  239. int&nbsp;depth)</pre>
  240. <div class="block">Constructs a <code>CancelException</code> with
  241. the file and depth when cancellation occurred.</div>
  242. <dl>
  243. <dt><span class="paramLabel">Parameters:</span></dt>
  244. <dd><code>file</code> - the file when the operation was cancelled, may be null</dd>
  245. <dd><code>depth</code> - the depth when the operation was cancelled, may be null</dd>
  246. </dl>
  247. </li>
  248. </ul>
  249. <a name="CancelException-java.lang.String-java.io.File-int-">
  250. <!-- -->
  251. </a>
  252. <ul class="blockListLast">
  253. <li class="blockList">
  254. <h4>CancelException</h4>
  255. <pre>public&nbsp;CancelException(<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;message,
  256. <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,
  257. int&nbsp;depth)</pre>
  258. <div class="block">Constructs a <code>CancelException</code> with
  259. an appropriate message and the file and depth when
  260. cancellation occurred.</div>
  261. <dl>
  262. <dt><span class="paramLabel">Parameters:</span></dt>
  263. <dd><code>message</code> - the detail message</dd>
  264. <dd><code>file</code> - the file when the operation was cancelled</dd>
  265. <dd><code>depth</code> - the depth when the operation was cancelled</dd>
  266. </dl>
  267. </li>
  268. </ul>
  269. </li>
  270. </ul>
  271. <!-- ============ METHOD DETAIL ========== -->
  272. <ul class="blockList">
  273. <li class="blockList"><a name="method.detail">
  274. <!-- -->
  275. </a>
  276. <h3>Method Detail</h3>
  277. <a name="getFile--">
  278. <!-- -->
  279. </a>
  280. <ul class="blockList">
  281. <li class="blockList">
  282. <h4>getFile</h4>
  283. <pre>public&nbsp;<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;getFile()</pre>
  284. <div class="block">Return the file when the operation was cancelled.</div>
  285. <dl>
  286. <dt><span class="returnLabel">Returns:</span></dt>
  287. <dd>the file when the operation was cancelled</dd>
  288. </dl>
  289. </li>
  290. </ul>
  291. <a name="getDepth--">
  292. <!-- -->
  293. </a>
  294. <ul class="blockListLast">
  295. <li class="blockList">
  296. <h4>getDepth</h4>
  297. <pre>public&nbsp;int&nbsp;getDepth()</pre>
  298. <div class="block">Return the depth when the operation was cancelled.</div>
  299. <dl>
  300. <dt><span class="returnLabel">Returns:</span></dt>
  301. <dd>the depth when the operation was cancelled</dd>
  302. </dl>
  303. </li>
  304. </ul>
  305. </li>
  306. </ul>
  307. </li>
  308. </ul>
  309. </div>
  310. </div>
  311. <!-- ========= END OF CLASS DATA ========= -->
  312. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  313. <div class="bottomNav"><a name="navbar.bottom">
  314. <!-- -->
  315. </a>
  316. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  317. <a name="navbar.bottom.firstrow">
  318. <!-- -->
  319. </a>
  320. <ul class="navList" title="Navigation">
  321. <li><a href="../../../../overview-summary.html">Overview</a></li>
  322. <li><a href="package-summary.html">Package</a></li>
  323. <li class="navBarCell1Rev">Class</li>
  324. <li><a href="class-use/DirectoryWalker.CancelException.html">Use</a></li>
  325. <li><a href="package-tree.html">Tree</a></li>
  326. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  327. <li><a href="../../../../index-all.html">Index</a></li>
  328. <li><a href="../../../../help-doc.html">Help</a></li>
  329. </ul>
  330. </div>
  331. <div class="subNav">
  332. <ul class="navList">
  333. <li><a href="../../../../org/apache/commons/io/DirectoryWalker.html" title="class in org.apache.commons.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  334. <li><a href="../../../../org/apache/commons/io/EndianUtils.html" title="class in org.apache.commons.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  335. </ul>
  336. <ul class="navList">
  337. <li><a href="../../../../index.html?org/apache/commons/io/DirectoryWalker.CancelException.html" target="_top">Frames</a></li>
  338. <li><a href="DirectoryWalker.CancelException.html" target="_top">No&nbsp;Frames</a></li>
  339. </ul>
  340. <ul class="navList" id="allclasses_navbar_bottom">
  341. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  342. </ul>
  343. <div>
  344. <script type="text/javascript"><!--
  345. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  346. if(window==top) {
  347. allClassesLink.style.display = "block";
  348. }
  349. else {
  350. allClassesLink.style.display = "none";
  351. }
  352. //-->
  353. </script>
  354. </div>
  355. <div>
  356. <ul class="subNavList">
  357. <li>Summary:&nbsp;</li>
  358. <li>Nested&nbsp;|&nbsp;</li>
  359. <li>Field&nbsp;|&nbsp;</li>
  360. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  361. <li><a href="#method.summary">Method</a></li>
  362. </ul>
  363. <ul class="subNavList">
  364. <li>Detail:&nbsp;</li>
  365. <li>Field&nbsp;|&nbsp;</li>
  366. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  367. <li><a href="#method.detail">Method</a></li>
  368. </ul>
  369. </div>
  370. <a name="skip.navbar.bottom">
  371. <!-- -->
  372. </a></div>
  373. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  374. <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>
  375. </body>
  376. </html>