Package org.apache.commons.io.comparator
Class PathFileComparator
java.lang.Object
org.apache.commons.io.comparator.PathFileComparator
- All Implemented Interfaces:
- Serializable,- Comparator<File>
Compare the path of two files for order (see 
File.getPath()).
 
 This comparator can be used to sort lists or arrays of files
 by their path either in a case-sensitive, case-insensitive or
 system dependent case-sensitive way. A number of singleton instances
 are provided for the various case sensitivity options (using IOCase)
 and the reverse of those options.
 
 Example of a case-sensitive file path sort using the
 PATH_COMPARATOR singleton instance:
 
       List<File> list = ...
       ((AbstractFileComparator) PathFileComparator.PATH_COMPARATOR).sort(list);
 
 
 Example of a reverse case-insensitive file path sort using the
 PATH_INSENSITIVE_REVERSE singleton instance:
 
       File[] array = ...
       ((AbstractFileComparator) PathFileComparator.PATH_INSENSITIVE_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> Case-sensitive path comparator instance (seeIOCase.SENSITIVE)static final Comparator<File> Case-insensitive path comparator instance (seeIOCase.INSENSITIVE)static final Comparator<File> Reverse case-insensitive path comparator instance (seeIOCase.INSENSITIVE)static final Comparator<File> Reverse case-sensitive path comparator instance (seeIOCase.SENSITIVE)static final Comparator<File> System sensitive path comparator instance (seeIOCase.SYSTEM)static final Comparator<File> Reverse system sensitive path comparator instance (seeIOCase.SYSTEM)
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs a case-sensitive file path comparator instance.PathFileComparator(IOCase ioCase) Constructs a file path comparator instance with the specified case-sensitivity.
- 
Method SummaryMethods 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- 
PATH_COMPARATORCase-sensitive path comparator instance (seeIOCase.SENSITIVE)
- 
PATH_REVERSEReverse case-sensitive path comparator instance (seeIOCase.SENSITIVE)
- 
PATH_INSENSITIVE_COMPARATORCase-insensitive path comparator instance (seeIOCase.INSENSITIVE)
- 
PATH_INSENSITIVE_REVERSEReverse case-insensitive path comparator instance (seeIOCase.INSENSITIVE)
- 
PATH_SYSTEM_COMPARATORSystem sensitive path comparator instance (seeIOCase.SYSTEM)
- 
PATH_SYSTEM_REVERSEReverse system sensitive path comparator instance (seeIOCase.SYSTEM)
 
- 
- 
Constructor Details- 
PathFileComparatorpublic PathFileComparator()Constructs a case-sensitive file path comparator instance.
- 
PathFileComparatorConstructs a file path comparator instance with the specified case-sensitivity.- Parameters:
- ioCase- how to handle case sensitivity, null means case-sensitive
 
 
- 
- 
Method Details- 
compareCompares the paths of two files the specified case sensitivity.- Specified by:
- comparein interface- Comparator<File>
- Parameters:
- file1- The first file to compare
- file2- The second file to compare
- Returns:
- a negative value if the first file's path is less than the second, zero if the paths are the same and a positive value if the first files path is greater than the second file.
 
- 
toStringString representation of this file comparator.- Returns:
- String representation of this file comparator
 
- 
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
 
 
-