Package org.apache.commons.io.comparator
Class SizeFileComparator
- java.lang.Object
-
- org.apache.commons.io.comparator.AbstractFileComparator
-
- org.apache.commons.io.comparator.SizeFileComparator
-
- All Implemented Interfaces:
java.io.Serializable
,java.util.Comparator<java.io.File>
public class SizeFileComparator extends AbstractFileComparator implements java.io.Serializable
Compare the length/size of two files for order (seeFile.length()
andFileUtils.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
istrue
.- Since:
- 1.4
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private static long
serialVersionUID
static java.util.Comparator<java.io.File>
SIZE_COMPARATOR
Size comparator instance - directories are treated as zero sizestatic java.util.Comparator<java.io.File>
SIZE_REVERSE
Reverse size comparator instance - directories are treated as zero sizestatic java.util.Comparator<java.io.File>
SIZE_SUMDIR_COMPARATOR
Size comparator instance which sums the size of a directory's contents usingFileUtils.sizeOfDirectory(File)
static java.util.Comparator<java.io.File>
SIZE_SUMDIR_REVERSE
Reverse size comparator instance which sums the size of a directory's contents usingFileUtils.sizeOfDirectory(File)
private boolean
sumDirectoryContents
Whether the sum of the directory's contents should be calculated.
-
Constructor Summary
Constructors Constructor Description SizeFileComparator()
Construct a file size comparator instance (directories treated as zero size).SizeFileComparator(boolean sumDirectoryContents)
Construct a file size comparator instance specifying whether the size of the directory contents should be aggregated.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compare(java.io.File file1, java.io.File file2)
Compare the length of two files.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
-
SIZE_COMPARATOR
public static final java.util.Comparator<java.io.File> SIZE_COMPARATOR
Size comparator instance - directories are treated as zero size
-
SIZE_REVERSE
public static final java.util.Comparator<java.io.File> SIZE_REVERSE
Reverse size comparator instance - directories are treated as zero size
-
SIZE_SUMDIR_COMPARATOR
public static final java.util.Comparator<java.io.File> SIZE_SUMDIR_COMPARATOR
Size comparator instance which sums the size of a directory's contents usingFileUtils.sizeOfDirectory(File)
-
SIZE_SUMDIR_REVERSE
public static final java.util.Comparator<java.io.File> SIZE_SUMDIR_REVERSE
Reverse size comparator instance which sums the size of a directory's contents usingFileUtils.sizeOfDirectory(File)
-
sumDirectoryContents
private final boolean sumDirectoryContents
Whether the sum of the directory's contents should be calculated.
-
-
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
istrue
The size of directories is calculated usingFileUtils.sizeOfDirectory(File)
.- Parameters:
sumDirectoryContents
-true
if the sum of the directories' contents should be calculated, otherwisefalse
if directories should be treated as size zero (seeFileUtils.sizeOfDirectory(File)
).
-
-
Method Detail
-
compare
public int compare(java.io.File file1, java.io.File file2)
Compare the length of two files.- 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 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 java.lang.String toString()
String representation of this file comparator.- Overrides:
toString
in classAbstractFileComparator
- Returns:
- String representation of this file comparator
-
-