IO-89 - Correct AgeFileFilter Javadocs to reflect that it filters either newer files or files equal to or older than the cutoff. Correct SizeFileFilter Javadocs to reflect that it filters either smaller files or files equal to or larger than the threshold.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/io/trunk@463570 13f79535-47bb-0310-9956-ffa450edef68

Author: Niall Pemberton

src/java/org/apache/commons/io/filefilter/AgeFileFilter.java

@@ -22,7 +22,8 @@
 import org.apache.commons.io.FileUtils;
 
 /**
- * Filters files based on a cutoff time, can filter either older or newer files.
+ * Filters files based on a cutoff time, can filter either newer
+ * files or files equal to or older.
  * <p>
  * For example, to print all files and directories in the
  * current directory older than one day:
@@ -49,7 +50,8 @@ public class AgeFileFilter extends AbstractFileFilter {
     private boolean acceptOlder;
 
     /**
-     * Constructs a new age file filter for files older than a certain cutoff.
+     * Constructs a new age file filter for files equal to or older than
+     * a certain cutoff
      *
      * @param cutoff  the threshold age of the files
      */
@@ -62,16 +64,17 @@ public AgeFileFilter(long cutoff) {
      * of a certain cutoff.
      *
      * @param cutoff  the threshold age of the files
-     * @param acceptOlder  if true, older files are accepted, else newer ones
+     * @param acceptOlder  if true, older files (at or before the cutoff)
+     * are accepted, else newer ones (after the cutoff).
      */
     public AgeFileFilter(long cutoff, boolean acceptOlder) {
         this.acceptOlder = acceptOlder;
         this.cutoff = cutoff;
     }
 
     /**
-     * Constructs a new age file filter for files older than a certain
-     * cutoff date.
+     * Constructs a new age file filter for files older than (at or before)
+     * a certain cutoff date.
      *
      * @param cutoffDate  the threshold age of the files
      */
@@ -84,15 +87,16 @@ public AgeFileFilter(Date cutoffDate) {
      * of a certain cutoff date.
      *
      * @param cutoffDate  the threshold age of the files
-     * @param acceptOlder  if true, older files are accepted, else newer ones
+     * @param acceptOlder  if true, older files (at or before the cutoff)
+     * are accepted, else newer ones (after the cutoff).
      */
     public AgeFileFilter(Date cutoffDate, boolean acceptOlder) {
         this(cutoffDate.getTime(), acceptOlder);
     }
 
     /**
-     * Constructs a new age file filter for files older than a certain
-     * File (whose last modification time will be used as reference).
+     * Constructs a new age file filter for files older than (at or before)
+     * a certain File (whose last modification time will be used as reference).
      *
      * @param cutoffReference  the file whose last modification
      *        time is usesd as the threshold age of the files
@@ -108,7 +112,8 @@ public AgeFileFilter(File cutoffReference) {
      *
      * @param cutoffReference  the file whose last modification
      *        time is usesd as the threshold age of the files
-     * @param acceptOlder  if true, older files are accepted, else newer ones
+     * @param acceptOlder  if true, older files (at or before the cutoff)
+     * are accepted, else newer ones (after the cutoff).
      */
     public AgeFileFilter(File cutoffReference, boolean acceptOlder) {
         this(cutoffReference.lastModified(), acceptOlder);
@@ -118,7 +123,11 @@ public AgeFileFilter(File cutoffReference, boolean acceptOlder) {
     /**
      * Checks to see if the last modification of the file matches cutoff
      * favorably.
-     * If last modification time equals cutoff, file is not selected.
+     * <p>
+     * If last modification time equals cutoff and newer files are required,
+     * file <b>IS NOT</b> selected.
+     * If last modification time equals cutoff and older files are required,
+     * file <b>IS</b> selected.
      *
      * @param file  the File to check
      * @return true if the filename matches

src/java/org/apache/commons/io/filefilter/SizeFileFilter.java

@@ -19,8 +19,8 @@
 import java.io.File;
 
 /**
- * Filters files based on size, can filter either larger or smaller files
- * as compared to a given threshold.
+ * Filters files based on size, can filter either smaller files or
+ * files equal to or larger than a given threshold.
  * <p>
  * For example, to print all files and directories in the
  * current directory whose size is greater than 1 MB:
@@ -45,7 +45,8 @@ public class SizeFileFilter extends AbstractFileFilter {
     private boolean acceptLarger;
 
     /**
-     * Constructs a new size file filter for files larger than a certain size.
+     * Constructs a new size file filter for files equal to or 
+     * larger than a certain size.
      *
      * @param size  the threshold size of the files
      * @throws IllegalArgumentException if the size is negative
@@ -59,7 +60,8 @@ public SizeFileFilter(long size) {
      * threshold.
      *
      * @param size  the threshold size of the files
-     * @param acceptLarger  if true, larger files are accepted, else smaller ones
+     * @param acceptLarger  if true, files equal to or larger are accepted,
+     * otherwise smaller ones (but not equal to)
      * @throws IllegalArgumentException if the size is negative
      */
     public SizeFileFilter(long size, boolean acceptLarger) {
@@ -73,7 +75,11 @@ public SizeFileFilter(long size, boolean acceptLarger) {
     //-----------------------------------------------------------------------
     /**
      * Checks to see if the size of the file is favorable.
-     * If size equals threshold, file is not selected.
+     * <p>
+     * If size equals threshold and smaller files are required,
+     * file <b>IS NOT</b> selected.
+     * If size equals threshold and larger files are required,
+     * file <b>IS</b> selected.
      *
      * @param file  the File to check
      * @return true if the filename matches