FileDocCategorySizeDatePackage
PathFileComparator.javaAPI DocAndroid 1.5 API4534Wed May 06 22:42:46 BST 2009org.apache.commons.io.comparator

PathFileComparator

public class PathFileComparator extends Object implements Serializable, Comparator
Compare the path of two files for order (see {@link 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 dependant case sensitive way. A number of singleton instances are provided for the various case sensitivity options (using {@link IOCase}) and the reverse of those options.

Example of a case-sensitive file path sort using the {@link #PATH_COMPARATOR} singleton instance: 

List<File> list = ...
Collections.sort(list, PathFileComparator.PATH_COMPARATOR);

Example of a reverse case-insensitive file path sort using the {@link #PATH_INSENSITIVE_REVERSE} singleton instance: 

File[] array = ...
Arrays.sort(array, PathFileComparator.PATH_INSENSITIVE_REVERSE);

version
$Revision: 609243 $ $Date: 2008-01-06 00:30:42 +0000 (Sun, 06 Jan 2008) $
since
Commons IO 1.4

Fields Summary
public static final Comparator
PATH_COMPARATOR
Case-sensitive path comparator instance (see {@link IOCase#SENSITIVE})
public static final Comparator
PATH_REVERSE
Reverse case-sensitive path comparator instance (see {@link IOCase#SENSITIVE})
public static final Comparator
PATH_INSENSITIVE_COMPARATOR
Case-insensitive path comparator instance (see {@link IOCase#INSENSITIVE})
public static final Comparator
PATH_INSENSITIVE_REVERSE
Reverse case-insensitive path comparator instance (see {@link IOCase#INSENSITIVE})
public static final Comparator
PATH_SYSTEM_COMPARATOR
System sensitive path comparator instance (see {@link IOCase#SYSTEM})
public static final Comparator
PATH_SYSTEM_REVERSE
Reverse system sensitive path comparator instance (see {@link IOCase#SYSTEM})
private final IOCase
caseSensitivity
Whether the comparison is case sensitive.
Constructors Summary
public PathFileComparator()
Construct a case sensitive file path comparator instance.


                 
      
        this.caseSensitivity = IOCase.SENSITIVE;
public PathFileComparator(IOCase caseSensitivity)
Construct a file path comparator instance with the specified case-sensitivity.

param
caseSensitivity how to handle case sensitivity, null means case-sensitive

        this.caseSensitivity = caseSensitivity == null ? IOCase.SENSITIVE : caseSensitivity;
Methods Summary
public intcompare(java.lang.Object obj1, java.lang.Object obj2)
Compare the paths of two files the specified case sensitivity.

param
obj1 The first file to compare
param
obj2 The second file to compare
return
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.

        File file1 = (File)obj1;
        File file2 = (File)obj2;
        return caseSensitivity.checkCompareTo(file1.getPath(), file2.getPath());