IO-442: Javadoc contradictory for FileFilterUtils.ageFileFilter(cutoff) and the filter it constructs: AgeFileFilter(cutoff)

PascalSchumacher · PascalSchumacher · commit 156653ea56fe · 2017-04-23T20:44:33.000+02:00
correct FileFilterUtils.ageFileFilter(cutoff) javadoc
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -47,6 +47,9 @@ The <action> type attribute can be add,update,fix,remove.
   <body>
     <!-- The release date is the date RC is cut -->
     <release version="2.6" date="2017-MM-DD" description="New features and bug fixes.">
+      <action issue="IO-442" dev="pschumacher" type="fix" due-to="Simon Robinson">
+        Javadoc contradictory for FileFilterUtils.ageFileFilter(cutoff) and the filter it constructs: AgeFileFilter(cutoff)
+      </action>
       <action issue="IO-534" dev="sebb" type="fix">
         FileUtilTestCase.testForceDeleteDir() should not delete testDirectory parent
       </action>
diff --git a/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java b/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java
@@ -518,8 +518,8 @@ public static IOFileFilter asFileFilter(final FilenameFilter filter) {
 
     //-----------------------------------------------------------------------
     /**
-     * Returns a filter that returns true if the file was last modified after
-     * the specified cutoff time.
+     * Returns a filter that returns true if the file was last modified before
+     * or at the specified cutoff time.
      *
      * @param cutoff  the time threshold
      * @return an appropriately configured age file filter
@@ -544,8 +544,8 @@ public static IOFileFilter ageFileFilter(final long cutoff, final boolean accept
     }
 
     /**
-     * Returns a filter that returns true if the file was last modified after
-     * the specified cutoff date.
+     * Returns a filter that returns true if the file was last modified before
+     * or at the specified cutoff date.
      *
      * @param cutoffDate  the time threshold
      * @return an appropriately configured age file filter
@@ -570,8 +570,8 @@ public static IOFileFilter ageFileFilter(final Date cutoffDate, final boolean ac
     }
 
     /**
-     * Returns a filter that returns true if the file was last modified after
-     * the specified reference file.
+     * Returns a filter that returns true if the file was last modified before
+     * or at the same time as the specified reference file.
      *
      * @param cutoffReference  the file whose last modification
      *        time is used as the threshold age of the files

Original file line number	Diff line number	Diff line change
`@@ -518,8 +518,8 @@ public static IOFileFilter asFileFilter(final FilenameFilter filter) {`
`518`	`518`
`519`	`519`	`//-----------------------------------------------------------------------`
`520`	`520`	`/**`
`521`		`- * Returns a filter that returns true if the file was last modified after`
`522`		`- * the specified cutoff time.`
	`521`	`+ * Returns a filter that returns true if the file was last modified before`
	`522`	`+ * or at the specified cutoff time.`
`523`	`523`	`*`
`524`	`524`	`* @param cutoff the time threshold`
`525`	`525`	`* @return an appropriately configured age file filter`
`@@ -544,8 +544,8 @@ public static IOFileFilter ageFileFilter(final long cutoff, final boolean accept`
`544`	`544`	`}`
`545`	`545`
`546`	`546`	`/**`
`547`		`- * Returns a filter that returns true if the file was last modified after`
`548`		`- * the specified cutoff date.`
	`547`	`+ * Returns a filter that returns true if the file was last modified before`
	`548`	`+ * or at the specified cutoff date.`
`549`	`549`	`*`
`550`	`550`	`* @param cutoffDate the time threshold`
`551`	`551`	`* @return an appropriately configured age file filter`
`@@ -570,8 +570,8 @@ public static IOFileFilter ageFileFilter(final Date cutoffDate, final boolean ac`
`570`	`570`	`}`
`571`	`571`
`572`	`572`	`/**`
`573`		`- * Returns a filter that returns true if the file was last modified after`
`574`		`- * the specified reference file.`
	`573`	`+ * Returns a filter that returns true if the file was last modified before`
	`574`	`+ * or at the same time as the specified reference file.`
`575`	`575`	`*`
`576`	`576`	`* @param cutoffReference the file whose last modification`
`577`	`577`	`* time is used as the threshold age of the files`