Skip to content

Commit 8575fc5

Browse files
garydgregorygarydgregory
committed
[IO-343] org.apache.commons.io.comparator Javadoc is inconsistent with real code.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@1378539 13f79535-47bb-0310-9956-ffa450edef68
1 parent ead0697 commit 8575fc5

16 files changed

Lines changed: 42 additions & 45 deletions

‎src/changes/changes.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ The <action> type attribute can be add,update,fix,remove.
4747
<body>
4848
<!-- The release date is the date RC is cut -->
4949
<release version="2.4" date="2012-06-12" description="New features and bug fixes.">
50+
<action issue="IO-343" dev="ggregory" type="fix" due-to="igorlash">
51+
org.apache.commons.io.comparator Javadoc is inconsistent with real code.
52+
</action>
5053
<action issue="IO-336" dev="ggregory" type="fix" due-to="rleavelle">
5154
Yottabyte (YB) incorrectly defined in FileUtils.
5255
</action>

‎src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818

1919
import java.io.File;
2020
import java.io.Serializable;
21-
import java.util.Comparator;
2221

2322
/**
2423
* Compare two files using the <b>default</b> {@link File#compareTo(File)} method.
@@ -46,11 +45,11 @@
4645
*/
4746
public class DefaultFileComparator extends AbstractFileComparator implements Serializable {
4847

49-
/** Singleton default comparator instance */
50-
public static final Comparator<File> DEFAULT_COMPARATOR = new DefaultFileComparator();
48+
/** Singleton default comparator instance */
49+
public static final DefaultFileComparator DEFAULT_COMPARATOR = new DefaultFileComparator();
5150

5251
/** Singleton reverse default comparator instance */
53-
public static final Comparator<File> DEFAULT_REVERSE = new ReverseComparator(DEFAULT_COMPARATOR);
52+
public static final ReverseComparator DEFAULT_REVERSE = new ReverseComparator(DEFAULT_COMPARATOR);
5453

5554
/**
5655
* Compare the two files using the {@link File#compareTo(File)} method.

‎src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818

1919
import java.io.File;
2020
import java.io.Serializable;
21-
import java.util.Comparator;
2221

2322
/**
2423
* Compare two files using the {@link File#isDirectory()} method.
@@ -45,11 +44,12 @@
4544
*/
4645
public class DirectoryFileComparator extends AbstractFileComparator implements Serializable {
4746

48-
/** Singleton default comparator instance */
49-
public static final Comparator<File> DIRECTORY_COMPARATOR = new DirectoryFileComparator();
47+
48+
/** Singleton default comparator instance */
49+
public static final DirectoryFileComparator DIRECTORY_COMPARATOR = new DirectoryFileComparator();
5050

5151
/** Singleton reverse default comparator instance */
52-
public static final Comparator<File> DIRECTORY_REVERSE = new ReverseComparator(DIRECTORY_COMPARATOR);
52+
public static final ReverseComparator DIRECTORY_REVERSE = new ReverseComparator(DIRECTORY_COMPARATOR);
5353

5454
/**
5555
* Compare the two files using the {@link File#isDirectory()} method.

‎src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818

1919
import java.io.File;
2020
import java.io.Serializable;
21-
import java.util.Comparator;
2221

2322
import org.apache.commons.io.FilenameUtils;
2423
import org.apache.commons.io.IOCase;
@@ -54,24 +53,24 @@
5453
public class ExtensionFileComparator extends AbstractFileComparator implements Serializable {
5554

5655
/** Case-sensitive extension comparator instance (see {@link IOCase#SENSITIVE}) */
57-
public static final Comparator<File> EXTENSION_COMPARATOR = new ExtensionFileComparator();
56+
public static final ExtensionFileComparator EXTENSION_COMPARATOR = new ExtensionFileComparator();
5857

5958
/** Reverse case-sensitive extension comparator instance (see {@link IOCase#SENSITIVE}) */
60-
public static final Comparator<File> EXTENSION_REVERSE = new ReverseComparator(EXTENSION_COMPARATOR);
59+
public static final ReverseComparator EXTENSION_REVERSE = new ReverseComparator(EXTENSION_COMPARATOR);
6160

6261
/** Case-insensitive extension comparator instance (see {@link IOCase#INSENSITIVE}) */
63-
public static final Comparator<File> EXTENSION_INSENSITIVE_COMPARATOR
62+
public static final ExtensionFileComparator EXTENSION_INSENSITIVE_COMPARATOR
6463
= new ExtensionFileComparator(IOCase.INSENSITIVE);
6564

6665
/** Reverse case-insensitive extension comparator instance (see {@link IOCase#INSENSITIVE}) */
67-
public static final Comparator<File> EXTENSION_INSENSITIVE_REVERSE
66+
public static final ReverseComparator EXTENSION_INSENSITIVE_REVERSE
6867
= new ReverseComparator(EXTENSION_INSENSITIVE_COMPARATOR);
6968

7069
/** System sensitive extension comparator instance (see {@link IOCase#SYSTEM}) */
71-
public static final Comparator<File> EXTENSION_SYSTEM_COMPARATOR = new ExtensionFileComparator(IOCase.SYSTEM);
70+
public static final ExtensionFileComparator EXTENSION_SYSTEM_COMPARATOR = new ExtensionFileComparator(IOCase.SYSTEM);
7271

7372
/** Reverse system sensitive path comparator instance (see {@link IOCase#SYSTEM}) */
74-
public static final Comparator<File> EXTENSION_SYSTEM_REVERSE = new ReverseComparator(EXTENSION_SYSTEM_COMPARATOR);
73+
public static final ReverseComparator EXTENSION_SYSTEM_REVERSE = new ReverseComparator(EXTENSION_SYSTEM_COMPARATOR);
7574

7675
/** Whether the comparison is case sensitive. */
7776
private final IOCase caseSensitivity;

‎src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818

1919
import java.io.File;
2020
import java.io.Serializable;
21-
import java.util.Comparator;
2221

2322
/**
2423
* Compare the <b>last modified date/time</b> of two files for order
@@ -48,10 +47,10 @@
4847
public class LastModifiedFileComparator extends AbstractFileComparator implements Serializable {
4948

5049
/** Last modified comparator instance */
51-
public static final Comparator<File> LASTMODIFIED_COMPARATOR = new LastModifiedFileComparator();
50+
public static final LastModifiedFileComparator LASTMODIFIED_COMPARATOR = new LastModifiedFileComparator();
5251

5352
/** Reverse last modified comparator instance */
54-
public static final Comparator<File> LASTMODIFIED_REVERSE = new ReverseComparator(LASTMODIFIED_COMPARATOR);
53+
public static final ReverseComparator LASTMODIFIED_REVERSE = new ReverseComparator(LASTMODIFIED_COMPARATOR);
5554

5655
/**
5756
* Compare the last the last modified date/time of two files.

‎src/main/java/org/apache/commons/io/comparator/NameFileComparator.java‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818

1919
import java.io.File;
2020
import java.io.Serializable;
21-
import java.util.Comparator;
2221

2322
import org.apache.commons.io.IOCase;
2423

@@ -52,22 +51,22 @@
5251
public class NameFileComparator extends AbstractFileComparator implements Serializable {
5352

5453
/** Case-sensitive name comparator instance (see {@link IOCase#SENSITIVE}) */
55-
public static final Comparator<File> NAME_COMPARATOR = new NameFileComparator();
54+
public static final NameFileComparator NAME_COMPARATOR = new NameFileComparator();
5655

5756
/** Reverse case-sensitive name comparator instance (see {@link IOCase#SENSITIVE}) */
58-
public static final Comparator<File> NAME_REVERSE = new ReverseComparator(NAME_COMPARATOR);
57+
public static final ReverseComparator NAME_REVERSE = new ReverseComparator(NAME_COMPARATOR);
5958

6059
/** Case-insensitive name comparator instance (see {@link IOCase#INSENSITIVE}) */
61-
public static final Comparator<File> NAME_INSENSITIVE_COMPARATOR = new NameFileComparator(IOCase.INSENSITIVE);
60+
public static final NameFileComparator NAME_INSENSITIVE_COMPARATOR = new NameFileComparator(IOCase.INSENSITIVE);
6261

6362
/** Reverse case-insensitive name comparator instance (see {@link IOCase#INSENSITIVE}) */
64-
public static final Comparator<File> NAME_INSENSITIVE_REVERSE = new ReverseComparator(NAME_INSENSITIVE_COMPARATOR);
63+
public static final ReverseComparator NAME_INSENSITIVE_REVERSE = new ReverseComparator(NAME_INSENSITIVE_COMPARATOR);
6564

6665
/** System sensitive name comparator instance (see {@link IOCase#SYSTEM}) */
67-
public static final Comparator<File> NAME_SYSTEM_COMPARATOR = new NameFileComparator(IOCase.SYSTEM);
66+
public static final NameFileComparator NAME_SYSTEM_COMPARATOR = new NameFileComparator(IOCase.SYSTEM);
6867

6968
/** Reverse system sensitive name comparator instance (see {@link IOCase#SYSTEM}) */
70-
public static final Comparator<File> NAME_SYSTEM_REVERSE = new ReverseComparator(NAME_SYSTEM_COMPARATOR);
69+
public static final ReverseComparator NAME_SYSTEM_REVERSE = new ReverseComparator(NAME_SYSTEM_COMPARATOR);
7170

7271
/** Whether the comparison is case sensitive. */
7372
private final IOCase caseSensitivity;

‎src/main/java/org/apache/commons/io/comparator/PathFileComparator.java‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818

1919
import java.io.File;
2020
import java.io.Serializable;
21-
import java.util.Comparator;
2221

2322
import org.apache.commons.io.IOCase;
2423

@@ -52,22 +51,22 @@
5251
public class PathFileComparator extends AbstractFileComparator implements Serializable {
5352

5453
/** Case-sensitive path comparator instance (see {@link IOCase#SENSITIVE}) */
55-
public static final Comparator<File> PATH_COMPARATOR = new PathFileComparator();
54+
public static final PathFileComparator PATH_COMPARATOR = new PathFileComparator();
5655

5756
/** Reverse case-sensitive path comparator instance (see {@link IOCase#SENSITIVE}) */
58-
public static final Comparator<File> PATH_REVERSE = new ReverseComparator(PATH_COMPARATOR);
57+
public static final ReverseComparator PATH_REVERSE = new ReverseComparator(PATH_COMPARATOR);
5958

6059
/** Case-insensitive path comparator instance (see {@link IOCase#INSENSITIVE}) */
61-
public static final Comparator<File> PATH_INSENSITIVE_COMPARATOR = new PathFileComparator(IOCase.INSENSITIVE);
60+
public static final PathFileComparator PATH_INSENSITIVE_COMPARATOR = new PathFileComparator(IOCase.INSENSITIVE);
6261

6362
/** Reverse case-insensitive path comparator instance (see {@link IOCase#INSENSITIVE}) */
64-
public static final Comparator<File> PATH_INSENSITIVE_REVERSE = new ReverseComparator(PATH_INSENSITIVE_COMPARATOR);
63+
public static final ReverseComparator PATH_INSENSITIVE_REVERSE = new ReverseComparator(PATH_INSENSITIVE_COMPARATOR);
6564

6665
/** System sensitive path comparator instance (see {@link IOCase#SYSTEM}) */
67-
public static final Comparator<File> PATH_SYSTEM_COMPARATOR = new PathFileComparator(IOCase.SYSTEM);
66+
public static final PathFileComparator PATH_SYSTEM_COMPARATOR = new PathFileComparator(IOCase.SYSTEM);
6867

6968
/** Reverse system sensitive path comparator instance (see {@link IOCase#SYSTEM}) */
70-
public static final Comparator<File> PATH_SYSTEM_REVERSE = new ReverseComparator(PATH_SYSTEM_COMPARATOR);
69+
public static final ReverseComparator PATH_SYSTEM_REVERSE = new ReverseComparator(PATH_SYSTEM_COMPARATOR);
7170

7271
/** Whether the comparison is case sensitive. */
7372
private final IOCase caseSensitivity;

‎src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818

1919
import java.io.File;
2020
import java.io.Serializable;
21-
import java.util.Comparator;
2221

2322
import org.apache.commons.io.FileUtils;
2423

@@ -52,22 +51,22 @@
5251
public class SizeFileComparator extends AbstractFileComparator implements Serializable {
5352

5453
/** Size comparator instance - directories are treated as zero size */
55-
public static final Comparator<File> SIZE_COMPARATOR = new SizeFileComparator();
54+
public static final SizeFileComparator SIZE_COMPARATOR = new SizeFileComparator();
5655

5756
/** Reverse size comparator instance - directories are treated as zero size */
58-
public static final Comparator<File> SIZE_REVERSE = new ReverseComparator(SIZE_COMPARATOR);
57+
public static final ReverseComparator SIZE_REVERSE = new ReverseComparator(SIZE_COMPARATOR);
5958

6059
/**
6160
* Size comparator instance which sums the size of a directory's contents
6261
* using {@link FileUtils#sizeOfDirectory(File)}
6362
*/
64-
public static final Comparator<File> SIZE_SUMDIR_COMPARATOR = new SizeFileComparator(true);
63+
public static final SizeFileComparator SIZE_SUMDIR_COMPARATOR = new SizeFileComparator(true);
6564

6665
/**
6766
* Reverse size comparator instance which sums the size of a directory's contents
6867
* using {@link FileUtils#sizeOfDirectory(File)}
6968
*/
70-
public static final Comparator<File> SIZE_SUMDIR_REVERSE = new ReverseComparator(SIZE_SUMDIR_COMPARATOR);
69+
public static final ReverseComparator SIZE_SUMDIR_REVERSE = new ReverseComparator(SIZE_SUMDIR_COMPARATOR);
7170

7271
/** Whether the sum of the directory's contents should be calculated. */
7372
private final boolean sumDirectoryContents;

‎src/test/java/org/apache/commons/io/comparator/ComparatorAbstractTestCase.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public ComparatorAbstractTestCase(String name) {
5858
/** @see junit.framework.TestCase#setUp() */
5959
@Override
6060
protected void setUp() throws Exception {
61-
comparator = (AbstractFileComparator)DefaultFileComparator.DEFAULT_COMPARATOR;
61+
comparator = DefaultFileComparator.DEFAULT_COMPARATOR;
6262
reverse = DefaultFileComparator.DEFAULT_REVERSE;
6363
}
6464

‎src/test/java/org/apache/commons/io/comparator/DefaultFileComparatorTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public DefaultFileComparatorTest(String name) {
3636
@Override
3737
protected void setUp() throws Exception {
3838
super.setUp();
39-
comparator = (AbstractFileComparator)DefaultFileComparator.DEFAULT_COMPARATOR;
39+
comparator = DefaultFileComparator.DEFAULT_COMPARATOR;
4040
reverse = DefaultFileComparator.DEFAULT_REVERSE;
4141
equalFile1 = new File("foo");
4242
equalFile2 = new File("foo");

0 commit comments

Comments
 (0)