svn commit: r1469107 - /commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/

[se...@apache.org]

Author: sebb
Date: Wed Apr 17 23:45:53 2013
New Revision: 1469107

URL: http://svn.apache.org/r1469107
Log:
[IO-343] org.apache.commons.io.comparator Javadoc is inconsistent with real code.
Fix Javadoc to agree with code

Modified:
    commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
    commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java
    commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java
    commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java
    commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
    commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java
    commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java
    commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java

Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java?rev=1469107&r1=1469106&r2=1469107&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java Wed Apr 17 23:45:53 2013
@@ -33,8 +33,8 @@ import java.util.List;
  * <pre>
  *       CompositeFileComparator comparator =
  *                       new CompositeFileComparator(
- *                                   DirectoryFileComparator.DIRECTORY_COMPARATOR,
- *                                   NameFileComparator.NAME_COMPARATOR);
+ *                                 (AbstractFileComparator) DirectoryFileComparator.DIRECTORY_COMPARATOR,
+ *                                 (AbstractFileComparator) NameFileComparator.NAME_COMPARATOR);
  *       List&lt;File&gt; list = ...
  *       comparator.sort(list);
  * </pre>

Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java?rev=1469107&r1=1469106&r2=1469107&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java Wed Apr 17 23:45:53 2013
@@ -30,14 +30,14 @@ import java.util.Comparator;
  * {@link #DEFAULT_COMPARATOR} singleton instance:
  * <pre>
  *       List&lt;File&gt; list = ...
- *       DefaultFileComparator.DEFAULT_COMPARATOR.sort(list);
+ *       ((AbstractFileComparator) DefaultFileComparator.DEFAULT_COMPARATOR).sort(list);
  * </pre>
  * <p>
  * Example of doing a <i>reverse</i> sort of an array of files using the
  * {@link #DEFAULT_REVERSE} singleton instance:
  * <pre>
  *       File[] array = ...
- *       DefaultFileComparator.DEFAULT_REVERSE.sort(array);
+ *       ((AbstractFileComparator) DefaultFileComparator.DEFAULT_REVERSE).sort(array);
  * </pre>
  * <p>
  *

Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java?rev=1469107&r1=1469106&r2=1469107&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java Wed Apr 17 23:45:53 2013
@@ -29,14 +29,14 @@ import java.util.Comparator;
  * {@link #DIRECTORY_COMPARATOR} singleton instance:
  * <pre>
  *       List&lt;File&gt; list = ...
- *       DirectoryFileComparator.DIRECTORY_COMPARATOR.sort(list);
+ *       ((AbstractFileComparator) DirectoryFileComparator.DIRECTORY_COMPARATOR).sort(list);
  * </pre>
  * <p>
  * Example of doing a <i>reverse</i> sort of an array of files/directories using the
  * {@link #DIRECTORY_REVERSE} singleton instance:
  * <pre>
  *       File[] array = ...
- *       DirectoryFileComparator.DIRECTORY_REVERSE.sort(array);
+ *       ((AbstractFileComparator) DirectoryFileComparator.DIRECTORY_REVERSE).sort(array);
  * </pre>
  * <p>
  *

Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java?rev=1469107&r1=1469106&r2=1469107&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java Wed Apr 17 23:45:53 2013
@@ -37,14 +37,14 @@ import org.apache.commons.io.IOCase;
  * {@link #EXTENSION_COMPARATOR} singleton instance:
  * <pre>
  *       List&lt;File&gt; list = ...
- *       ExtensionFileComparator.EXTENSION_COMPARATOR.sort(list);
+ *       ((AbstractFileComparator) ExtensionFileComparator.EXTENSION_COMPARATOR).sort(list);
  * </pre>
  * <p>
  * Example of a <i>reverse case-insensitive</i> file extension sort using the
  * {@link #EXTENSION_INSENSITIVE_REVERSE} singleton instance:
  * <pre>
  *       File[] array = ...
- *       ExtensionFileComparator.EXTENSION_INSENSITIVE_REVERSE.sort(array);
+ *       ((AbstractFileComparator) ExtensionFileComparator.EXTENSION_INSENSITIVE_REVERSE).sort(array);
  * </pre>
  * <p>
  *

Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java?rev=1469107&r1=1469106&r2=1469107&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java Wed Apr 17 23:45:53 2013
@@ -31,14 +31,14 @@ import java.util.Comparator;
  * {@link #LASTMODIFIED_COMPARATOR} singleton instance:
  * <pre>
  *       List&lt;File&gt; list = ...
- *       LastModifiedFileComparator.LASTMODIFIED_COMPARATOR.sort(list);
+ *       ((AbstractFileComparator) LastModifiedFileComparator.LASTMODIFIED_COMPARATOR).sort(list);
  * </pre>
  * <p>
  * Example of doing a <i>reverse</i> sort of an array of files using the
  * {@link #LASTMODIFIED_REVERSE} singleton instance:
  * <pre>
  *       File[] array = ...
- *       LastModifiedFileComparator.LASTMODIFIED_REVERSE.sort(array);
+ *       ((AbstractFileComparator) LastModifiedFileComparator.LASTMODIFIED_REVERSE).sort(array);
  * </pre>
  * <p>
  *

Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java?rev=1469107&r1=1469106&r2=1469107&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java Wed Apr 17 23:45:53 2013
@@ -35,14 +35,14 @@ import org.apache.commons.io.IOCase;
  * {@link #NAME_COMPARATOR} singleton instance:
  * <pre>
  *       List&lt;File&gt; list = ...
- *       NameFileComparator.NAME_COMPARATOR.sort(list);
+ *       ((AbstractFileComparator) NameFileComparator.NAME_COMPARATOR).sort(list);
  * </pre>
  * <p>
  * Example of a <i>reverse case-insensitive</i> file name sort using the
  * {@link #NAME_INSENSITIVE_REVERSE} singleton instance:
  * <pre>
  *       File[] array = ...
- *       NameFileComparator.NAME_INSENSITIVE_REVERSE.sort(array);
+ *       ((AbstractFileComparator) NameFileComparator.NAME_INSENSITIVE_REVERSE).sort(array);
  * </pre>
  * <p>
  *

Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java?rev=1469107&r1=1469106&r2=1469107&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java Wed Apr 17 23:45:53 2013
@@ -35,14 +35,14 @@ import org.apache.commons.io.IOCase;
  * {@link #PATH_COMPARATOR} singleton instance:
  * <pre>
  *       List&lt;File&gt; list = ...
- *       PathFileComparator.PATH_COMPARATOR.sort(list);
+ *       ((AbstractFileComparator) PathFileComparator.PATH_COMPARATOR).sort(list);
  * </pre>
  * <p>
  * Example of a <i>reverse case-insensitive</i> file path sort using the
  * {@link #PATH_INSENSITIVE_REVERSE} singleton instance:
  * <pre>
  *       File[] array = ...
- *       PathFileComparator.PATH_INSENSITIVE_REVERSE.sort(array);
+ *       ((AbstractFileComparator) PathFileComparator.PATH_INSENSITIVE_REVERSE).sort(array);
  * </pre>
  * <p>
  *

Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java?rev=1469107&r1=1469106&r2=1469107&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java Wed Apr 17 23:45:53 2013
@@ -33,14 +33,14 @@ import org.apache.commons.io.FileUtils;
  * {@link #SIZE_COMPARATOR} singleton instance:
  * <pre>
  *       List&lt;File&gt; list = ...
- *       SizeFileComparator.SIZE_COMPARATOR.sort(list);
+ *       ((AbstractFileComparator) SizeFileComparator.SIZE_COMPARATOR).sort(list);
  * </pre>
  * <p>
  * Example of doing a <i>reverse</i> sort of an array of files using the
  * {@link #SIZE_REVERSE} singleton instance:
  * <pre>
  *       File[] array = ...
- *       SizeFileComparator.SIZE_REVERSE.sort(array);
+ *       ((AbstractFileComparator) SizeFileComparator.SIZE_REVERSE).sort(array);
  * </pre>
  * <p>
  * <strong>N.B.</strong> Directories are treated as <b>zero size</b> unless