Package org.apache.commons.io.comparator
Class DefaultFileComparator
java.lang.Object
org.apache.commons.io.comparator.DefaultFileComparator
- All Implemented Interfaces:
- Serializable,- Comparator<File>
Compares 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);
 
 Deprecating Serialization
Serialization is deprecated and will be removed in 3.0.
- Since:
- 1.4
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final Comparator<File> Singleton default comparator instancestatic final Comparator<File> Singleton reverse default comparator instance
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionintCompares the two files using theFile.compareTo(File)method.File[]Sorts an array of files.Sorts a List of files.toString()String representation of this file comparator.Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Comparatorequals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
- 
Field Details- 
DEFAULT_COMPARATORSingleton default comparator instance
- 
DEFAULT_REVERSESingleton reverse default comparator instance
 
- 
- 
Constructor Details- 
DefaultFileComparatorpublic DefaultFileComparator()Constructs a new instance.
 
- 
- 
Method Details- 
compareCompares the two files using theFile.compareTo(File)method.- Specified by:
- comparein interface- Comparator<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.
 
- 
sortSorts 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
 
- 
sortSorts a List of files.This method uses List.sort(Comparator)and returns the original list.- Parameters:
- files- The files to sort, may be null.
- Returns:
- The sorted list.
- Since:
- 2.0
 
- 
toStringString representation of this file comparator.
 
-