Package org.apache.commons.io.comparator

Class DefaultFileComparator

  • All Implemented Interfaces:
    java.io.Serializable, java.util.Comparator<java.io.File>
    public class DefaultFileComparator
extends java.lang.Object
implements java.io.Serializable
    Compares 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 = ...
       ((AbstractFileComparator) DefaultFileComparator.DEFAULT_COMPARATOR).sort(list);

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

           File[] array = ...
       ((AbstractFileComparator) DefaultFileComparator.DEFAULT_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> 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()
      Constructs a new instance.

    • 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 two files using the File.compareTo(File) method.
      java.io.File[] sort​(java.io.File... files)
      Sorts an array of files.
      java.util.List<java.io.File> sort​(java.util.List<java.io.File> files)
      Sorts a List of files.
      java.lang.String toString()
      String representation of this file comparator.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Comparator

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

    • 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()
        Constructs a new instance.

    • Method Detail

      • compare

        public int compare​(java.io.File file1,
                   java.io.File file2)
        Compares 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.

      • sort

        public java.io.File[] sort​(java.io.File... files)
        Sorts an array of files.

        This method uses Arrays.sort(Object[], Comparator) and returns the original array.

        Parameters:
        files - The files to sort, may be null.
        Returns:
        The sorted array.
        Since:
        2.0

      • sort

        public java.util.List<java.io.File> sort​(java.util.List<java.io.File> files)
        Sorts a List of files.

        This method uses List.sort(Comparator) and returns the original list.

        Parameters:
        files - The files to sort, may be null.
        Returns:
        The sorted list.
        Since:
        2.0

      • toString

        public java.lang.String toString()
        String representation of this file comparator.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String representation of this file comparator.