Package org.apache.commons.io.comparator
Class CompositeFileComparator
java.lang.Object
org.apache.commons.io.comparator.CompositeFileComparator
- All Implemented Interfaces:
Serializable,Comparator<File>
Compare two files using a set of delegate file
Comparator.
This comparator can be used to sort lists or arrays of files by combining a number of other comparators.
Example of sorting a list of files by type (directory or file) and then by name:
CompositeFileComparator comparator = new CompositeFileComparator(
DirectoryFileComparator.DIRECTORY_COMPARATOR,
NameFileComparator.NAME_COMPARATOR);
List<File> list = ...
comparator.sort(list);
Deprecating Serialization
Serialization is deprecated and will be removed in 3.0.
- Since:
- 2.0
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionCompositeFileComparator(Iterable<Comparator<File>> delegates) Constructs a composite comparator for the set of delegate comparators.CompositeFileComparator(Comparator<File>... delegates) Constructs a composite comparator for the set of delegate comparators. -
Method Summary
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Comparator
equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
Constructor Details
-
CompositeFileComparator
Constructs a composite comparator for the set of delegate comparators.- Parameters:
delegates- The delegate file comparators
-
CompositeFileComparator
Constructs a composite comparator for the set of delegate comparators.- Parameters:
delegates- The delegate file comparators
-
-
Method Details
-
compare
Compares the two files using delegate comparators.- Specified by:
comparein interfaceComparator<File>- Parameters:
file1- The first file to comparefile2- The second file to compare- Returns:
- the first non-zero result returned from the delegate comparators or zero.
-
toString
String representation of this file comparator.- Returns:
- String representation of this file comparator
-
sort
Sorts 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
Sorts 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
-