Package org.apache.commons.io.comparator
Class DefaultFileComparator
- java.lang.Object
-
- org.apache.commons.io.comparator.DefaultFileComparator
-
- All Implemented Interfaces:
Serializable
,Comparator<File>
public class DefaultFileComparator extends Object implements Serializable
Compare two files using the defaultFile.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:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static Comparator<File>
DEFAULT_COMPARATOR
Singleton default comparator instancestatic Comparator<File>
DEFAULT_REVERSE
Singleton reverse default comparator instance
-
Constructor Summary
Constructors Constructor Description DefaultFileComparator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compare(File file1, File file2)
Compare the two files using theFile.compareTo(File)
method.File[]
sort(File... files)
Sort an array of files.List<File>
sort(List<File> files)
Sort a List of files.String
toString()
String representation of this file comparator.-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Comparator
equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
-
-
-
Field Detail
-
DEFAULT_COMPARATOR
public static final Comparator<File> DEFAULT_COMPARATOR
Singleton default comparator instance
-
DEFAULT_REVERSE
public static final Comparator<File> DEFAULT_REVERSE
Singleton reverse default comparator instance
-
-
Method Detail
-
compare
public int compare(File file1, File file2)
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
public File[] sort(File... files)
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
public List<File> sort(List<File> files)
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
-
-