Package org.apache.commons.io.comparator
Class DefaultFileComparator
java.lang.Object
org.apache.commons.io.comparator.DefaultFileComparator
- All Implemented Interfaces:
Serializable
,Comparator<File>
Compare two files using the default
File.compareTo(File)
method.
This comparator can be used to sort lists or arrays of files by using the default file comparison.
Example of sorting a list of files using the
DEFAULT_COMPARATOR
singleton instance:
List<File> list = ... ((AbstractFileComparator) DefaultFileComparator.DEFAULT_COMPARATOR).sort(list);
Example of doing a reverse sort of an array of files using the
DEFAULT_REVERSE
singleton instance:
File[] array = ... ((AbstractFileComparator) DefaultFileComparator.DEFAULT_REVERSE).sort(array);
- Since:
- 1.4
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Comparator
<File> Singleton default comparator instancestatic final Comparator
<File> Singleton reverse default comparator instance -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Compare the two files using theFile.compareTo(File)
method.File[]
Sort an array of files.Sort a List of files.toString()
String representation of this file comparator.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
-
DEFAULT_COMPARATOR
Singleton default comparator instance -
DEFAULT_REVERSE
Singleton reverse default comparator instance
-
-
Constructor Details
-
DefaultFileComparator
public DefaultFileComparator()
-
-
Method Details
-
compare
Compare the two files using theFile.compareTo(File)
method.- Specified by:
compare
in interfaceComparator<File>
- Parameters:
file1
- The first file to comparefile2
- The second file to compare- Returns:
- the result of calling file1's
File.compareTo(File)
with file2 as the parameter.
-
sort
Sort an array of files.This method uses
Arrays.sort(Object[], Comparator)
and returns the original array.- Parameters:
files
- The files to sort, may be null- Returns:
- The sorted array
- Since:
- 2.0
-
sort
Sort a List of files.This method uses
Collections.sort(List, Comparator)
and returns the original list.- Parameters:
files
- The files to sort, may be null- Returns:
- The sorted list
- Since:
- 2.0
-
toString
String representation of this file comparator.
-