[IO-872] PathUtils.directoryAndFileContentEquals doesn't work across

FileSystems

- Add SimplePathVisitor.AbstractBuilder
- Add CountingPathVisitor.AbstractBuilder and
CountingPathVisitor.Builder
- Add AccumulatorPathVisitor.Builder and builder(
- For now, keep as much of the new code private or package-private as
possible

Author: garydgregory

src/changes/changes.xml

@@ -90,6 +90,9 @@ The <action> type attribute can be add,update,fix,remove.
       <action dev="ggregory" type="add"                due-to="Gary Gregory">Add Uncheck.getAsBoolean(IOBooleanSupplier).</action>
       <action dev="ggregory" type="add"                due-to="Gary Gregory">Add FileChannels.contentEquals(SeekableByteChannel, SeekableByteChannel, int).</action>
       <action dev="ggregory" type="add"                due-to="Gary Gregory">Add FileChannels.contentEquals(ReadableByteChannel, ReadableByteChannel, int).</action>
+      <action dev="ggregory" type="add" issue="IO-872" due-to="Gary Gregory">Add SimplePathVisitor.AbstractBuilder.</action>
+      <action dev="ggregory" type="add" issue="IO-872" due-to="Gary Gregory">Add CountingPathVisitor.AbstractBuilder and CountingPathVisitor.Builder.</action>
+      <action dev="ggregory" type="add" issue="IO-872" due-to="Gary Gregory">Add AccumulatorPathVisitor.Builder and builder().</action>
       <!-- UPDATE -->
       <action dev="ggregory" type="update"             due-to="Dependabot, Gary Gregory">Bump commons.bytebuddy.version from 1.15.10 to 1.17.5 #710, #715, #720, #734, #735.</action>
       <action dev="ggregory" type="update"             due-to="Gary Gregory">Bump commons-codec:commons-codec from 1.17.1 to 1.18.0. #717.</action>

src/main/java/org/apache/commons/io/FileUtils.java

@@ -2282,8 +2282,14 @@ private static AccumulatorPathVisitor listAccumulate(final File directory, final
         final boolean isDirFilterSet = dirFilter != null;
         final FileEqualsFileFilter rootDirFilter = new FileEqualsFileFilter(directory);
         final PathFilter dirPathFilter = isDirFilterSet ? rootDirFilter.or(dirFilter) : rootDirFilter;
-        final AccumulatorPathVisitor visitor = new AccumulatorPathVisitor(Counters.noopPathCounters(), fileFilter, dirPathFilter,
-                (p, e) -> FileVisitResult.CONTINUE);
+        // @formatter:off
+        final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.builder()
+                .setPathCounters(Counters.noopPathCounters())
+                .setFileFilter(fileFilter)
+                .setDirectoryFilter(dirPathFilter)
+                .setVisitFileFailedFunction((p, e) -> FileVisitResult.CONTINUE)
+                .get();
+        // @formatter:on
         final Set<FileVisitOption> optionSet = new HashSet<>();
         if (options != null) {
             Collections.addAll(optionSet, options);

src/main/java/org/apache/commons/io/file/AccumulatorPathVisitor.java

@@ -60,13 +60,38 @@
  */
 public class AccumulatorPathVisitor extends CountingPathVisitor {
 
+    /**
+     * Builds instances of {@link AccumulatorPathVisitor}.
+     *
+     * @since 2.18.0
+     */
+    public static class Builder extends AbstractBuilder<AccumulatorPathVisitor, Builder> {
+        @Override
+        public AccumulatorPathVisitor get() {
+            return new AccumulatorPathVisitor(this);
+        }
+
+    }
+
+    /**
+     * Builds instances of {@link AccumulatorPathVisitor}.
+     *
+     * @return a new builder.
+     * @since 2.18.0
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
     /**
      * Constructs a new instance configured with a BigInteger {@link PathCounters}.
      *
      * @return a new instance configured with a BigInteger {@link PathCounters}.
+     * @see #builder()
+     * @see Builder
      */
     public static AccumulatorPathVisitor withBigIntegerCounters() {
-        return new AccumulatorPathVisitor(Counters.bigIntegerPathCounters());
+        return builder().setPathCounters(Counters.bigIntegerPathCounters()).get();
     }
 
     /**
@@ -75,20 +100,23 @@ public static AccumulatorPathVisitor withBigIntegerCounters() {
      * @param fileFilter Filters files to accumulate and count.
      * @param dirFilter Filters directories to accumulate and count.
      * @return a new instance configured with a long {@link PathCounters}.
+     * @see #builder()
+     * @see Builder
      * @since 2.9.0
      */
-    public static AccumulatorPathVisitor withBigIntegerCounters(final PathFilter fileFilter,
-        final PathFilter dirFilter) {
-        return new AccumulatorPathVisitor(Counters.bigIntegerPathCounters(), fileFilter, dirFilter);
+    public static AccumulatorPathVisitor withBigIntegerCounters(final PathFilter fileFilter, final PathFilter dirFilter) {
+        return builder().setPathCounters(Counters.bigIntegerPathCounters()).setFileFilter(fileFilter).setDirectoryFilter(dirFilter).get();
     }
 
     /**
      * Constructs a new instance configured with a long {@link PathCounters}.
      *
      * @return a new instance configured with a long {@link PathCounters}.
+     * @see #builder()
+     * @see Builder
      */
     public static AccumulatorPathVisitor withLongCounters() {
-        return new AccumulatorPathVisitor(Counters.longPathCounters());
+        return builder().setPathCounters(Counters.longPathCounters()).get();
     }
 
     /**
@@ -97,30 +125,40 @@ public static AccumulatorPathVisitor withLongCounters() {
      * @param fileFilter Filters files to accumulate and count.
      * @param dirFilter Filters directories to accumulate and count.
      * @return a new instance configured with a long {@link PathCounters}.
+     * @see #builder()
+     * @see Builder
      * @since 2.9.0
      */
     public static AccumulatorPathVisitor withLongCounters(final PathFilter fileFilter, final PathFilter dirFilter) {
-        return new AccumulatorPathVisitor(Counters.longPathCounters(), fileFilter, dirFilter);
+        return builder().setPathCounters(Counters.longPathCounters()).setFileFilter(fileFilter).setDirectoryFilter(dirFilter).get();
     }
 
     private final List<Path> dirList = new ArrayList<>();
 
     private final List<Path> fileList = new ArrayList<>();
 
     /**
-     * Constructs a new instance.
+     * Constructs a new instance with a noop path counter.
      *
      * @since 2.9.0
+     * @deprecated Use {@link #builder()}.
      */
+    @Deprecated
     public AccumulatorPathVisitor() {
         super(Counters.noopPathCounters());
     }
 
+    private AccumulatorPathVisitor(final Builder builder) {
+        super(builder);
+    }
+
     /**
      * Constructs a new instance that counts file system elements.
      *
      * @param pathCounter How to count path visits.
+     * @deprecated Use {@link #builder()}.
      */
+    @Deprecated
     public AccumulatorPathVisitor(final PathCounters pathCounter) {
         super(pathCounter);
     }
@@ -132,7 +170,9 @@ public AccumulatorPathVisitor(final PathCounters pathCounter) {
      * @param fileFilter Filters which files to count.
      * @param dirFilter Filters which directories to count.
      * @since 2.9.0
+     * @deprecated Use {@link #builder()}.
      */
+    @Deprecated
     public AccumulatorPathVisitor(final PathCounters pathCounter, final PathFilter fileFilter, final PathFilter dirFilter) {
         super(pathCounter, fileFilter, dirFilter);
     }
@@ -145,7 +185,9 @@ public AccumulatorPathVisitor(final PathCounters pathCounter, final PathFilter f
      * @param dirFilter Filters which directories to count.
      * @param visitFileFailed Called on {@link #visitFileFailed(Path, IOException)}.
      * @since 2.12.0
+     * @deprecated Use {@link #builder()}.
      */
+    @Deprecated
     public AccumulatorPathVisitor(final PathCounters pathCounter, final PathFilter fileFilter, final PathFilter dirFilter,
         final IOBiFunction<Path, IOException, FileVisitResult> visitFileFailed) {
         super(pathCounter, fileFilter, dirFilter, visitFileFailed);