public class PathFileComparator extends AbstractFileComparator implements java.io.Serializable
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);
Modifier and Type | Field and Description |
---|---|
private IOCase |
caseSensitivity
Whether the comparison is case sensitive.
|
static java.util.Comparator<java.io.File> |
PATH_COMPARATOR
Case-sensitive path comparator instance (see
IOCase.SENSITIVE ) |
static java.util.Comparator<java.io.File> |
PATH_INSENSITIVE_COMPARATOR
Case-insensitive path comparator instance (see
IOCase.INSENSITIVE ) |
static java.util.Comparator<java.io.File> |
PATH_INSENSITIVE_REVERSE
Reverse case-insensitive path comparator instance (see
IOCase.INSENSITIVE ) |
static java.util.Comparator<java.io.File> |
PATH_REVERSE
Reverse case-sensitive path comparator instance (see
IOCase.SENSITIVE ) |
static java.util.Comparator<java.io.File> |
PATH_SYSTEM_COMPARATOR
System sensitive path comparator instance (see
IOCase.SYSTEM ) |
static java.util.Comparator<java.io.File> |
PATH_SYSTEM_REVERSE
Reverse system sensitive path comparator instance (see
IOCase.SYSTEM ) |
private static long |
serialVersionUID |
Constructor and Description |
---|
PathFileComparator()
Construct a case sensitive file path comparator instance.
|
PathFileComparator(IOCase caseSensitivity)
Construct a file path comparator instance with the specified case-sensitivity.
|
Modifier and Type | Method and Description |
---|---|
int |
compare(java.io.File file1,
java.io.File file2)
Compare the paths of two files the specified case sensitivity.
|
java.lang.String |
toString()
String representation of this file comparator.
|
sort, sort
private static final long serialVersionUID
public static final java.util.Comparator<java.io.File> PATH_COMPARATOR
IOCase.SENSITIVE
)public static final java.util.Comparator<java.io.File> PATH_REVERSE
IOCase.SENSITIVE
)public static final java.util.Comparator<java.io.File> PATH_INSENSITIVE_COMPARATOR
IOCase.INSENSITIVE
)public static final java.util.Comparator<java.io.File> PATH_INSENSITIVE_REVERSE
IOCase.INSENSITIVE
)public static final java.util.Comparator<java.io.File> PATH_SYSTEM_COMPARATOR
IOCase.SYSTEM
)public static final java.util.Comparator<java.io.File> PATH_SYSTEM_REVERSE
IOCase.SYSTEM
)private final IOCase caseSensitivity
public PathFileComparator()
public PathFileComparator(IOCase caseSensitivity)
caseSensitivity
- how to handle case sensitivity, null means case-sensitivepublic int compare(java.io.File file1, java.io.File file2)
compare
in interface java.util.Comparator<java.io.File>
file1
- The first file to comparefile2
- The second file to comparepublic java.lang.String toString()
toString
in class AbstractFileComparator