Package org.apache.commons.io.comparator

Class DefaultFileComparator

java.lang.Object

org.apache.commons.io.comparator.AbstractFileComparator

org.apache.commons.io.comparator.DefaultFileComparator

All Implemented Interfaces:

java.io.Serializable, java.util.Comparator<java.io.File>

public class DefaultFileComparator
extends AbstractFileComparator
implements java.io.Serializable

Compare two files using the default File.compareTo(File) method.

This comparator can be used to sort lists or arrays of files by using the default file comparison.

Example of sorting a list of files using the DEFAULT_COMPARATOR singleton instance:

       List<File> list = ...
       DefaultFileComparator.DEFAULT_COMPARATOR.sort(list);
 

Example of doing a reverse sort of an array of files using the DEFAULT_REVERSE singleton instance:

       File[] array = ...
       DefaultFileComparator.DEFAULT_REVERSE.sort(array);
 

Since:

1.4

Version:

$Id: DefaultFileComparator.java 1304052 2012-03-22 20:55:29Z ggregory $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Comparator<java.io.File>	DEFAULT_COMPARATOR	Singleton default comparator instance
static java.util.Comparator<java.io.File>	DEFAULT_REVERSE	Singleton reverse default comparator instance

Constructor Summary

Constructors

Constructor	Description
DefaultFileComparator()

Method Summary

Modifier and Type	Method	Description
int	compare(java.io.File file1, java.io.File file2)	Compare the two files using the File.compareTo(File) method.

Methods inherited from class org.apache.commons.io.comparator.AbstractFileComparator

sort, sort, toString

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_COMPARATOR

public static final java.util.Comparator<java.io.File> DEFAULT_COMPARATOR

Singleton default comparator instance

DEFAULT_REVERSE

public static final java.util.Comparator<java.io.File> DEFAULT_REVERSE

Singleton reverse default comparator instance

Constructor Detail

DefaultFileComparator

public DefaultFileComparator()

Method Detail

compare

public int compare(java.io.File file1,
                   java.io.File file2)

Compare the two files using the File.compareTo(File) method.

Specified by:

compare in interface java.util.Comparator<java.io.File>

Parameters:

file1 - The first file to compare

file2 - The second file to compare

Returns:

the result of calling file1's File.compareTo(File) with file2 as the parameter.