Package org.apache.commons.io.comparator
Class ExtensionFileComparator
- java.lang.Object
-
- org.apache.commons.io.comparator.AbstractFileComparator
-
- org.apache.commons.io.comparator.ExtensionFileComparator
-
- All Implemented Interfaces:
java.io.Serializable
,java.util.Comparator<java.io.File>
public class ExtensionFileComparator extends AbstractFileComparator implements java.io.Serializable
Compare the file name extensions for order (seeFilenameUtils.getExtension(String)
).This comparator can be used to sort lists or arrays of files by their file extension 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 extension sort using the
EXTENSION_COMPARATOR
singleton instance:List<File> list = ... ((AbstractFileComparator) ExtensionFileComparator.EXTENSION_COMPARATOR).sort(list);
Example of a reverse case-insensitive file extension sort using the
EXTENSION_INSENSITIVE_REVERSE
singleton instance:File[] array = ... ((AbstractFileComparator) ExtensionFileComparator.EXTENSION_INSENSITIVE_REVERSE).sort(array);
Deprecating Serialization
Serialization is deprecated and will be removed in 3.0.
- Since:
- 1.4
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.util.Comparator<java.io.File>
EXTENSION_COMPARATOR
Case-sensitive extension comparator instance (seeIOCase.SENSITIVE
)static java.util.Comparator<java.io.File>
EXTENSION_INSENSITIVE_COMPARATOR
Case-insensitive extension comparator instance (seeIOCase.INSENSITIVE
)static java.util.Comparator<java.io.File>
EXTENSION_INSENSITIVE_REVERSE
Reverse case-insensitive extension comparator instance (seeIOCase.INSENSITIVE
)static java.util.Comparator<java.io.File>
EXTENSION_REVERSE
Reverse case-sensitive extension comparator instance (seeIOCase.SENSITIVE
)static java.util.Comparator<java.io.File>
EXTENSION_SYSTEM_COMPARATOR
System sensitive extension comparator instance (seeIOCase.SYSTEM
)static java.util.Comparator<java.io.File>
EXTENSION_SYSTEM_REVERSE
Reverse system sensitive path comparator instance (seeIOCase.SYSTEM
)private IOCase
ioCase
Whether the comparison is case-sensitive.private static long
serialVersionUID
-
Constructor Summary
Constructors Constructor Description ExtensionFileComparator()
Constructs a case-sensitive file extension comparator instance.ExtensionFileComparator(IOCase ioCase)
Constructs a file extension comparator instance with the specified case-sensitivity.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compare(java.io.File file1, java.io.File file2)
Compares the extensions of two files the specified case sensitivity.java.lang.String
toString()
String representation of this file comparator.-
Methods inherited from class org.apache.commons.io.comparator.AbstractFileComparator
sort, sort
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
EXTENSION_COMPARATOR
public static final java.util.Comparator<java.io.File> EXTENSION_COMPARATOR
Case-sensitive extension comparator instance (seeIOCase.SENSITIVE
)
-
EXTENSION_REVERSE
public static final java.util.Comparator<java.io.File> EXTENSION_REVERSE
Reverse case-sensitive extension comparator instance (seeIOCase.SENSITIVE
)
-
EXTENSION_INSENSITIVE_COMPARATOR
public static final java.util.Comparator<java.io.File> EXTENSION_INSENSITIVE_COMPARATOR
Case-insensitive extension comparator instance (seeIOCase.INSENSITIVE
)
-
EXTENSION_INSENSITIVE_REVERSE
public static final java.util.Comparator<java.io.File> EXTENSION_INSENSITIVE_REVERSE
Reverse case-insensitive extension comparator instance (seeIOCase.INSENSITIVE
)
-
EXTENSION_SYSTEM_COMPARATOR
public static final java.util.Comparator<java.io.File> EXTENSION_SYSTEM_COMPARATOR
System sensitive extension comparator instance (seeIOCase.SYSTEM
)
-
EXTENSION_SYSTEM_REVERSE
public static final java.util.Comparator<java.io.File> EXTENSION_SYSTEM_REVERSE
Reverse system sensitive path comparator instance (seeIOCase.SYSTEM
)
-
ioCase
private final IOCase ioCase
Whether the comparison is case-sensitive.
-
-
Constructor Detail
-
ExtensionFileComparator
public ExtensionFileComparator()
Constructs a case-sensitive file extension comparator instance.
-
ExtensionFileComparator
public ExtensionFileComparator(IOCase ioCase)
Constructs a file extension comparator instance with the specified case-sensitivity.- Parameters:
ioCase
- how to handle case sensitivity, null means case-sensitive
-
-
Method Detail
-
compare
public int compare(java.io.File file1, java.io.File file2)
Compares the extensions of two files the specified case sensitivity.- Specified by:
compare
in interfacejava.util.Comparator<java.io.File>
- Parameters:
file1
- The first file to comparefile2
- The second file to compare- Returns:
- a negative value if the first file's extension is less than the second, zero if the extensions are the same and a positive value if the first files extension is greater than the second file.
-
toString
public java.lang.String toString()
String representation of this file comparator.- Overrides:
toString
in classAbstractFileComparator
- Returns:
- String representation of this file comparator
-
-