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

NameFileComparator

public class NameFileComparator extends Object implements Serializable, Comparator
Compare the names of two files for order (see {@link File#getName()}).

This comparator can be used to sort lists or arrays of files by their name 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 name sort using the {@link #NAME_COMPARATOR} singleton instance: 

List<File> list = ...
Collections.sort(list, NameFileComparator.NAME_COMPARATOR);

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

File[] array = ...
Arrays.sort(array, NameFileComparator.NAME_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
NAME_COMPARATOR
Case-sensitive name comparator instance (see {@link IOCase#SENSITIVE})
public static final Comparator
NAME_REVERSE
Reverse case-sensitive name comparator instance (see {@link IOCase#SENSITIVE})
public static final Comparator
NAME_INSENSITIVE_COMPARATOR
Case-insensitive name comparator instance (see {@link IOCase#INSENSITIVE})
public static final Comparator
NAME_INSENSITIVE_REVERSE
Reverse case-insensitive name comparator instance (see {@link IOCase#INSENSITIVE})
public static final Comparator
NAME_SYSTEM_COMPARATOR
System sensitive name comparator instance (see {@link IOCase#SYSTEM})
public static final Comparator
NAME_SYSTEM_REVERSE
Reverse system sensitive name comparator instance (see {@link IOCase#SYSTEM})
private final IOCase
caseSensitivity
Whether the comparison is case sensitive.
Constructors Summary
public NameFileComparator()
Construct a case sensitive file name comparator instance.


                 
      
        this.caseSensitivity = IOCase.SENSITIVE;
public NameFileComparator(IOCase caseSensitivity)
Construct a file name 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 names of two files with 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 name is less than the second, zero if the names are the same and a positive value if the first files name is greater than the second file.

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