Class SizeFileComparator

  • All Implemented Interfaces:
    Serializable, Comparator< File>

    public class SizeFileComparator
    extends Object
    implements Serializable
    Compare the length/size of two files for order (see File.length() and FileUtils.sizeOfDirectory(File)).

    This comparator can be used to sort lists or arrays of files by their length/size.

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

           List<File> list = ...
           ((AbstractFileComparator) SizeFileComparator.SIZE_COMPARATOR).sort(list);

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

           File[] array = ...
           ((AbstractFileComparator) SizeFileComparator.SIZE_REVERSE).sort(array);

    N.B. Directories are treated as zero size unless sumDirectoryContents is true.

    See Also:
    Serialized Form
    • Field Detail


        public static final Comparator<File> SIZE_COMPARATOR
        Size comparator instance - directories are treated as zero size

        public static final Comparator<File> SIZE_REVERSE
        Reverse size comparator instance - directories are treated as zero size
    • Constructor Detail

      • SizeFileComparator

        public SizeFileComparator()
        Construct a file size comparator instance (directories treated as zero size).
      • SizeFileComparator

        public SizeFileComparator(boolean sumDirectoryContents)
        Construct a file size comparator instance specifying whether the size of the directory contents should be aggregated.

        If the sumDirectoryContents is true The size of directories is calculated using FileUtils.sizeOfDirectory(File).

        sumDirectoryContents - true if the sum of the directories' contents should be calculated, otherwise false if directories should be treated as size zero (see FileUtils.sizeOfDirectory(File)).
    • Method Detail

      • compare

        public int compare(File file1,
                           File file2)
        Compare the length of two files.
        Specified by:
        compare in interface  Comparator<File>
        file1 - The first file to compare
        file2 - The second file to compare
        a negative value if the first file's length is less than the second, zero if the lengths are the same and a positive value if the first files length is greater than the second file.
      • toString

        public String toString()
        String representation of this file comparator.
        String representation of this file comparator
      • sort

        public File[] sort(File... files)
        Sort an array of files.

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

        files - The files to sort, may be null
        The sorted array

Copyright © 2002–2021 The Apache Software Foundation. All rights reserved.