Package org.apache.commons.io.comparator
Class DirectoryFileComparator
java.lang.Object
org.apache.commons.io.comparator.AbstractFileComparator
org.apache.commons.io.comparator.DirectoryFileComparator
- All Implemented Interfaces:
Serializable
,Comparator<File>
Compare two files using the
File.isDirectory()
method.
This comparator can be used to sort lists or arrays by directories and files.
Example of sorting a list of files/directories using the DIRECTORY_COMPARATOR
singleton instance:
List<File> list = ... ((AbstractFileComparator) DirectoryFileComparator.DIRECTORY_COMPARATOR).sort(list);
Example of doing a reverse sort of an array of files/directories using the DIRECTORY_REVERSE
singleton instance:
File[] array = ... ((AbstractFileComparator) DirectoryFileComparator.DIRECTORY_REVERSE).sort(array);
Deprecating Serialization
Serialization is deprecated and will be removed in 3.0.
- Since:
- 2.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Comparator<File>
Singleton default comparator instancestatic final Comparator<File>
Singleton reverse default comparator instanceprivate static final long
private static final int
private static final int
-
Constructor Summary
Constructors -
Method Summary
Methods inherited from class org.apache.commons.io.comparator.AbstractFileComparator
sort, sort, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Comparator
equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
Field Details
-
TYPE_FILE
private static final int TYPE_FILE- See Also:
-
TYPE_DIRECTORY
private static final int TYPE_DIRECTORY- See Also:
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
DIRECTORY_COMPARATOR
Singleton default comparator instance -
DIRECTORY_REVERSE
Singleton reverse default comparator instance
-
-
Constructor Details
-
DirectoryFileComparator
public DirectoryFileComparator()
-
-
Method Details
-
compare
Compares the two files using theFile.isDirectory()
method.- Specified by:
compare
in interfaceComparator<File>
- Parameters:
file1
- The first file to compare.file2
- The second file to compare.- Returns:
- the result of calling file1's
File.compareTo(File)
with file2 as the parameter.
-
getType
Converts type to numeric value.- Parameters:
file
- The file.- Returns:
- 1 for directories and 2 for files.
-