package-summary.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361
  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>org.apache.commons.io.comparator (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="org.apache.commons.io.comparator (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. </script>
  22. <noscript>
  23. <div>JavaScript is disabled on your browser.</div>
  24. </noscript>
  25. <!-- ========= START OF TOP NAVBAR ======= -->
  26. <div class="topNav"><a name="navbar.top">
  27. <!-- -->
  28. </a>
  29. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  30. <a name="navbar.top.firstrow">
  31. <!-- -->
  32. </a>
  33. <ul class="navList" title="Navigation">
  34. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  35. <li class="navBarCell1Rev">Package</li>
  36. <li>Class</li>
  37. <li><a href="package-use.html">Use</a></li>
  38. <li><a href="package-tree.html">Tree</a></li>
  39. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  40. <li><a href="../../../../../index-all.html">Index</a></li>
  41. <li><a href="../../../../../help-doc.html">Help</a></li>
  42. </ul>
  43. </div>
  44. <div class="subNav">
  45. <ul class="navList">
  46. <li><a href="../../../../../org/apache/commons/io/package-summary.html">Prev&nbsp;Package</a></li>
  47. <li><a href="../../../../../org/apache/commons/io/filefilter/package-summary.html">Next&nbsp;Package</a></li>
  48. </ul>
  49. <ul class="navList">
  50. <li><a href="../../../../../index.html?org/apache/commons/io/comparator/package-summary.html" target="_top">Frames</a></li>
  51. <li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
  52. </ul>
  53. <ul class="navList" id="allclasses_navbar_top">
  54. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  55. </ul>
  56. <div>
  57. <script type="text/javascript"><!--
  58. allClassesLink = document.getElementById("allclasses_navbar_top");
  59. if(window==top) {
  60. allClassesLink.style.display = "block";
  61. }
  62. else {
  63. allClassesLink.style.display = "none";
  64. }
  65. //-->
  66. </script>
  67. </div>
  68. <a name="skip.navbar.top">
  69. <!-- -->
  70. </a></div>
  71. <!-- ========= END OF TOP NAVBAR ========= -->
  72. <div class="header">
  73. <h1 title="Package" class="title">Package&nbsp;org.apache.commons.io.comparator</h1>
  74. <div class="docSummary">
  75. <div class="block">This package provides various <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a> implementations
  76. for <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a>s.</div>
  77. </div>
  78. <p>See:&nbsp;<a href="#package.description">Description</a></p>
  79. </div>
  80. <div class="contentContainer">
  81. <ul class="blockList">
  82. <li class="blockList">
  83. <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
  84. <caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
  85. <tr>
  86. <th class="colFirst" scope="col">Class</th>
  87. <th class="colLast" scope="col">Description</th>
  88. </tr>
  89. <tbody>
  90. <tr class="altColor">
  91. <td class="colFirst"><a href="../../../../../org/apache/commons/io/comparator/CompositeFileComparator.html" title="class in org.apache.commons.io.comparator">CompositeFileComparator</a></td>
  92. <td class="colLast">
  93. <div class="block">Compare two files using a set of delegate file <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a>.</div>
  94. </td>
  95. </tr>
  96. <tr class="rowColor">
  97. <td class="colFirst"><a href="../../../../../org/apache/commons/io/comparator/DefaultFileComparator.html" title="class in org.apache.commons.io.comparator">DefaultFileComparator</a></td>
  98. <td class="colLast">
  99. <div class="block">Compare two files using the <b>default</b> <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true#compareTo-java.io.File-" title="class or interface in java.io"><code>File.compareTo(File)</code></a> method.</div>
  100. </td>
  101. </tr>
  102. <tr class="altColor">
  103. <td class="colFirst"><a href="../../../../../org/apache/commons/io/comparator/DirectoryFileComparator.html" title="class in org.apache.commons.io.comparator">DirectoryFileComparator</a></td>
  104. <td class="colLast">
  105. <div class="block">Compare two files using the <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true#isDirectory--" title="class or interface in java.io"><code>File.isDirectory()</code></a> method.</div>
  106. </td>
  107. </tr>
  108. <tr class="rowColor">
  109. <td class="colFirst"><a href="../../../../../org/apache/commons/io/comparator/ExtensionFileComparator.html" title="class in org.apache.commons.io.comparator">ExtensionFileComparator</a></td>
  110. <td class="colLast">
  111. <div class="block">Compare the file name <b>extensions</b> for order
  112. (see <a href="../../../../../org/apache/commons/io/FilenameUtils.html#getExtension-java.lang.String-"><code>FilenameUtils.getExtension(String)</code></a>).</div>
  113. </td>
  114. </tr>
  115. <tr class="altColor">
  116. <td class="colFirst"><a href="../../../../../org/apache/commons/io/comparator/LastModifiedFileComparator.html" title="class in org.apache.commons.io.comparator">LastModifiedFileComparator</a></td>
  117. <td class="colLast">
  118. <div class="block">Compare the <b>last modified date/time</b> of two files for order
  119. (see <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true#lastModified--" title="class or interface in java.io"><code>File.lastModified()</code></a>).</div>
  120. </td>
  121. </tr>
  122. <tr class="rowColor">
  123. <td class="colFirst"><a href="../../../../../org/apache/commons/io/comparator/NameFileComparator.html" title="class in org.apache.commons.io.comparator">NameFileComparator</a></td>
  124. <td class="colLast">
  125. <div class="block">Compare the <b>names</b> of two files for order (see <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true#getName--" title="class or interface in java.io"><code>File.getName()</code></a>).</div>
  126. </td>
  127. </tr>
  128. <tr class="altColor">
  129. <td class="colFirst"><a href="../../../../../org/apache/commons/io/comparator/PathFileComparator.html" title="class in org.apache.commons.io.comparator">PathFileComparator</a></td>
  130. <td class="colLast">
  131. <div class="block">Compare the <b>path</b> of two files for order (see <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true#getPath--" title="class or interface in java.io"><code>File.getPath()</code></a>).</div>
  132. </td>
  133. </tr>
  134. <tr class="rowColor">
  135. <td class="colFirst"><a href="../../../../../org/apache/commons/io/comparator/SizeFileComparator.html" title="class in org.apache.commons.io.comparator">SizeFileComparator</a></td>
  136. <td class="colLast">
  137. <div class="block">Compare the <b>length/size</b> of two files for order (see
  138. <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true#length--" title="class or interface in java.io"><code>File.length()</code></a> and <a href="../../../../../org/apache/commons/io/FileUtils.html#sizeOfDirectory-java.io.File-"><code>FileUtils.sizeOfDirectory(File)</code></a>).</div>
  139. </td>
  140. </tr>
  141. </tbody>
  142. </table>
  143. </li>
  144. </ul>
  145. <a name="package.description">
  146. <!-- -->
  147. </a>
  148. <h2 title="Package org.apache.commons.io.comparator Description">Package org.apache.commons.io.comparator Description</h2>
  149. <div class="block"><p>This package provides various <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a> implementations
  150. for <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a>s.
  151. </p>
  152. <h3>Sorting</h3>
  153. <p>
  154. All the compartors include <i>convenience</i> utility <code>sort(File...)</code> and
  155. <code>sort(List)</code> methods.
  156. </p>
  157. <p>
  158. For example, to sort the files in a directory by name:
  159. </p>
  160. <pre>
  161. File[] files = dir.listFiles();
  162. NameFileComparator.NAME_COMPARATOR.sort(files);
  163. </pre>
  164. <p>
  165. ...alternatively you can do this in one line:
  166. </p>
  167. <pre>
  168. File[] files = NameFileComparator.NAME_COMPARATOR.sort(dir.listFiles());
  169. </pre>
  170. <h3>Composite Comparator</h3>
  171. <p>
  172. The <a href="CompositeFileComparator.html">CompositeFileComparator</a> can be used
  173. to compare (and sort lists or arrays of files) by combining a number other comparators.
  174. </p>
  175. <p>
  176. For example, to sort an array of files by type (i.e. directory or file)
  177. and then by name:
  178. </p>
  179. <pre>
  180. CompositeFileComparator comparator =
  181. new CompositeFileComparator(
  182. DirectoryFileComparator.DIRECTORY_COMPARATOR,
  183. NameFileComparator.NAME_COMPARATOR);
  184. File[] files = dir.listFiles();
  185. comparator.sort(files);
  186. </pre>
  187. <h3>Singleton Instances (thread-safe)</h3>
  188. <p>
  189. The <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a> implementations have some <i>convenience</i>
  190. singleton(<i>thread-safe</i>) instances ready to use:
  191. </p>
  192. <ul>
  193. <li><a href="DefaultFileComparator.html">DefaultFileComparator</a> - default file compare:
  194. <ul>
  195. <li><a href="DefaultFileComparator.html#DEFAULT_COMPARATOR">DEFAULT_COMPARATOR</a>
  196. - Compare using <code>File.compareTo(File)</code> method.
  197. </li>
  198. <li><a href="DefaultFileComparator.html#DEFAULT_REVERSE">DEFAULT_REVERSE</a>
  199. - Reverse compare of <code>File.compareTo(File)</code> method.
  200. </li>
  201. </ul>
  202. </li>
  203. <li><a href="DirectoryFileComparator.html">DirectoryFileComparator</a> - compare by type (directory or file):
  204. <ul>
  205. <li><a href="DirectoryFileComparator.html#DIRECTORY_COMPARATOR">DIRECTORY_COMPARATOR</a>
  206. - Compare using <code>File.isDirectory()</code> method (directories &lt; files).
  207. </li>
  208. <li><a href="DirectoryFileComparator.html#DIRECTORY_REVERSE">DIRECTORY_REVERSE</a>
  209. - Reverse compare of <code>File.isDirectory()</code> method (directories &gt;files).
  210. </li>
  211. </ul>
  212. </li>
  213. <li><a href="ExtensionFileComparator.html">ExtensionFileComparator</a> - compare file extenstions:
  214. <ul>
  215. <li><a href="ExtensionFileComparator.html#EXTENSION_COMPARATOR">EXTENSION_COMPARATOR</a>
  216. - Compare using <code>FilenameUtils.getExtension(String)</code> method.
  217. </li>
  218. <li><a href="ExtensionFileComparator.html#EXTENSION_REVERSE">EXTENSION_REVERSE</a>
  219. - Reverse compare of <code>FilenameUtils.getExtension(String)</code> method.
  220. </li>
  221. <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_COMPARATOR">EXTENSION_INSENSITIVE_COMPARATOR</a>
  222. - Case-insensitive compare using <code>FilenameUtils.getExtension(String)</code> method.
  223. </li>
  224. <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_REVERSE">EXTENSION_INSENSITIVE_REVERSE</a>
  225. - Reverse case-insensitive compare of <code>FilenameUtils.getExtension(String)</code> method.
  226. </li>
  227. <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_COMPARATOR">EXTENSION_SYSTEM_COMPARATOR</a>
  228. - System sensitive compare using <code>FilenameUtils.getExtension(String)</code> method.
  229. </li>
  230. <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_REVERSE">EXTENSION_SYSTEM_REVERSE</a>
  231. - Reverse system sensitive compare of <code>FilenameUtils.getExtension(String)</code> method.
  232. </li>
  233. </ul>
  234. </li>
  235. <li><a href="LastModifiedFileComparator.html">LastModifiedFileComparator</a>
  236. - compare the file's last modified date/time:
  237. <ul>
  238. <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_COMPARATOR">LASTMODIFIED_COMPARATOR</a>
  239. - Compare using <code>File.lastModified()</code> method.
  240. </li>
  241. <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_REVERSE">LASTMODIFIED_REVERSE</a>
  242. - Reverse compare of <code>File.lastModified()</code> method.
  243. </li>
  244. </ul>
  245. </li>
  246. <li><a href="NameFileComparator.html">NameFileComparator</a> - compare file names:
  247. <ul>
  248. <li><a href="NameFileComparator.html#NAME_COMPARATOR">NAME_COMPARATOR</a>
  249. - Compare using <code>File.getName()</code> method.
  250. </li>
  251. <li><a href="NameFileComparator.html#NAME_REVERSE">NAME_REVERSE</a>
  252. - Reverse compare of <code>File.getName()</code> method.
  253. </li>
  254. <li><a href="NameFileComparator.html#NAME_INSENSITIVE_COMPARATOR">NAME_INSENSITIVE_COMPARATOR</a>
  255. - Case-insensitive compare using <code>File.getName()</code> method.
  256. </li>
  257. <li><a href="NameFileComparator.html#NAME_INSENSITIVE_REVERSE">NAME_INSENSITIVE_REVERSE</a>
  258. - Reverse case-insensitive compare of <code>File.getName()</code> method.
  259. </li>
  260. <li><a href="NameFileComparator.html#NAME_SYSTEM_COMPARATOR">NAME_SYSTEM_COMPARATOR</a>
  261. - System sensitive compare using <code>File.getName()</code> method.
  262. </li>
  263. <li><a href="NameFileComparator.html#NAME_SYSTEM_REVERSE">NAME_SYSTEM_REVERSE</a>
  264. - Reverse system sensitive compare of <code>File.getName()</code> method.
  265. </li>
  266. </ul>
  267. </li>
  268. <li><a href="PathFileComparator.html">PathFileComparator</a> - compare file paths:
  269. <ul>
  270. <li><a href="PathFileComparator.html#PATH_COMPARATOR">PATH_COMPARATOR</a>
  271. - Compare using <code>File.getPath()</code> method.
  272. </li>
  273. <li><a href="PathFileComparator.html#PATH_REVERSE">PATH_REVERSE</a>
  274. - Reverse compare of <code>File.getPath()</code> method.
  275. </li>
  276. <li><a href="PathFileComparator.html#PATH_INSENSITIVE_COMPARATOR">PATH_INSENSITIVE_COMPARATOR</a>
  277. - Case-insensitive compare using <code>File.getPath()</code> method.
  278. </li>
  279. <li><a href="PathFileComparator.html#PATH_INSENSITIVE_REVERSE">PATH_INSENSITIVE_REVERSE</a>
  280. - Reverse case-insensitive compare of <code>File.getPath()</code> method.
  281. </li>
  282. <li><a href="PathFileComparator.html#PATH_SYSTEM_COMPARATOR">PATH_SYSTEM_COMPARATOR</a>
  283. - System sensitive compare using <code>File.getPath()</code> method.
  284. </li>
  285. <li><a href="PathFileComparator.html#PATH_SYSTEM_REVERSE">PATH_SYSTEM_REVERSE</a>
  286. - Reverse system sensitive compare of <code>File.getPath()</code> method.
  287. </li>
  288. </ul>
  289. </li>
  290. <li><a href="SizeFileComparator.html">SizeFileComparator</a> - compare the file's size:
  291. <ul>
  292. <li><a href="SizeFileComparator.html#SIZE_COMPARATOR">SIZE_COMPARATOR</a>
  293. - Compare using <code>File.length()</code> method (directories treated as zero length).
  294. </li>
  295. <li><a href="SizeFileComparator.html#SIZE_REVERSE">LASTMODIFIED_REVERSE</a>
  296. - Reverse compare of <code>File.length()</code> method (directories treated as zero length).
  297. </li>
  298. <li><a href="SizeFileComparator.html#SIZE_SUMDIR_COMPARATOR">SIZE_SUMDIR_COMPARATOR</a>
  299. - Compare using <code>FileUtils.sizeOfDirectory(File)</code> method
  300. (sums the size of a directory's contents).
  301. </li>
  302. <li><a href="SizeFileComparator.html#SIZE_SUMDIR_REVERSE">SIZE_SUMDIR_REVERSE</a>
  303. - Reverse compare of <code>FileUtils.sizeOfDirectory(File)</code> method
  304. (sums the size of a directory's contents).
  305. </li>
  306. </ul>
  307. </li>
  308. </ul></div>
  309. </div>
  310. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  311. <div class="bottomNav"><a name="navbar.bottom">
  312. <!-- -->
  313. </a>
  314. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  315. <a name="navbar.bottom.firstrow">
  316. <!-- -->
  317. </a>
  318. <ul class="navList" title="Navigation">
  319. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  320. <li class="navBarCell1Rev">Package</li>
  321. <li>Class</li>
  322. <li><a href="package-use.html">Use</a></li>
  323. <li><a href="package-tree.html">Tree</a></li>
  324. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  325. <li><a href="../../../../../index-all.html">Index</a></li>
  326. <li><a href="../../../../../help-doc.html">Help</a></li>
  327. </ul>
  328. </div>
  329. <div class="subNav">
  330. <ul class="navList">
  331. <li><a href="../../../../../org/apache/commons/io/package-summary.html">Prev&nbsp;Package</a></li>
  332. <li><a href="../../../../../org/apache/commons/io/filefilter/package-summary.html">Next&nbsp;Package</a></li>
  333. </ul>
  334. <ul class="navList">
  335. <li><a href="../../../../../index.html?org/apache/commons/io/comparator/package-summary.html" target="_top">Frames</a></li>
  336. <li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
  337. </ul>
  338. <ul class="navList" id="allclasses_navbar_bottom">
  339. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  340. </ul>
  341. <div>
  342. <script type="text/javascript"><!--
  343. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  344. if(window==top) {
  345. allClassesLink.style.display = "block";
  346. }
  347. else {
  348. allClassesLink.style.display = "none";
  349. }
  350. //-->
  351. </script>
  352. </div>
  353. <a name="skip.navbar.bottom">
  354. <!-- -->
  355. </a></div>
  356. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  357. <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>
  358. </body>
  359. </html>