org.apache.commons.io.comparator

Class DefaultFileComparator

Implemented Interfaces:
Comparator, Serializable

public class DefaultFileComparator
extends java.lang.Object
implements Comparator, 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 = ...
       Collections.sort(list, DefaultFileComparator.DEFAULT_COMPARATOR);
 

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

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

Version:
$Revision: 609243 $ $Date: 2008-01-06 00:30:42 +0000 (Sun, 06 Jan 2008) $
Since:
Commons IO 1.4

Field Summary

static Comparator
DEFAULT_COMPARATOR
Singleton default comparator instance
static Comparator
DEFAULT_REVERSE
Singleton reverse default comparator instance

Method Summary

int
compare(Object obj1, Object obj2)
Compare the two files using the File.compareTo(File) method.

Field Details

DEFAULT_COMPARATOR

public static final Comparator DEFAULT_COMPARATOR
Singleton default comparator instance

DEFAULT_REVERSE

public static final Comparator DEFAULT_REVERSE
Singleton reverse default comparator instance

Method Details

compare

public int compare(Object obj1,
                   Object obj2)
Compare the two files using the File.compareTo(File) method.
Parameters:
obj1 - The first file to compare
obj2 - The second file to compare
Returns:
the result of calling file1's File.compareTo(File) with file2 as the parameter.

Copyright (c) 2002-2008 Apache Software Foundation