Package org.apache.commons.io.comparator
Class PathFileComparator
java.lang.Object
org.apache.commons.io.comparator.AbstractFileComparator
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 Summary
FieldsModifier and TypeFieldDescriptionprivate final IOCase
Whether the comparison is case-sensitive.static 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
)private static final long
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a case-sensitive file path comparator instance.PathFileComparator
(IOCase ioCase) Constructs a file path comparator instance with the specified case-sensitivity. -
Method Summary
Methods inherited from class org.apache.commons.io.comparator.AbstractFileComparator
sort, sort
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Comparator
equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
PATH_COMPARATOR
Case-sensitive path comparator instance (seeIOCase.SENSITIVE
) -
PATH_REVERSE
Reverse case-sensitive path comparator instance (seeIOCase.SENSITIVE
) -
PATH_INSENSITIVE_COMPARATOR
Case-insensitive path comparator instance (seeIOCase.INSENSITIVE
) -
PATH_INSENSITIVE_REVERSE
Reverse case-insensitive path comparator instance (seeIOCase.INSENSITIVE
) -
PATH_SYSTEM_COMPARATOR
System sensitive path comparator instance (seeIOCase.SYSTEM
) -
PATH_SYSTEM_REVERSE
Reverse system sensitive path comparator instance (seeIOCase.SYSTEM
) -
ioCase
Whether the comparison is case-sensitive.
-
-
Constructor Details
-
PathFileComparator
public PathFileComparator()Constructs a case-sensitive file path comparator instance. -
PathFileComparator
Constructs a file path comparator instance with the specified case-sensitivity.- Parameters:
ioCase
- how to handle case sensitivity, null means case-sensitive
-
-
Method Details
-
compare
Compares the paths of two files the specified case sensitivity.- Specified by:
compare
in interfaceComparator<File>
- Parameters:
file1
- The first file to comparefile2
- 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.
-
toString
String representation of this file comparator.- Overrides:
toString
in classAbstractFileComparator
- Returns:
- String representation of this file comparator
-