[commons-vfs] branch master updated: [VFS-821] Deprecate FileSelector#traverseDescendents in favor of traverseDescendants

[gg...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-vfs.git


The following commit(s) were added to refs/heads/master by this push:
     new 3c1809a7 [VFS-821] Deprecate FileSelector#traverseDescendents in favor of traverseDescendants
3c1809a7 is described below

commit 3c1809a77dc11dc3e76497e7dd3ecfbfd315ce86
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Jul 16 08:14:16 2022 -0400

    [VFS-821] Deprecate FileSelector#traverseDescendents in favor of
    traverseDescendants
---
 .../java/org/apache/commons/vfs2/FileSelector.java | 24 +++++++++++++++++++---
 .../commons/vfs2/InvertIncludeFileSelector.java    |  2 +-
 .../commons/vfs2/provider/AbstractFileObject.java  |  2 +-
 3 files changed, 23 insertions(+), 5 deletions(-)

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelector.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelector.java
index b386ce0a..944e96ab 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelector.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelector.java
@@ -17,14 +17,14 @@
 package org.apache.commons.vfs2;
 
 /**
- * This interface is used to select files when traversing a file hierarchy.
+ * Selects what to traverse a file hierarchy.
  *
  * @see Selectors
  */
 public interface FileSelector {
 
     /**
-     * Determines if a file or folder should be selected. This method is called in depthwise order (that is, it is
+     * Tests if a file or folder should be selected. This method is called in depthwise order (that is, it is
      * called for the children of a folder before it is called for the folder itself).
      *
      * @param fileInfo the file or folder to select.
@@ -34,7 +34,7 @@ public interface FileSelector {
     boolean includeFile(FileSelectInfo fileInfo) throws Exception;
 
     /**
-     * Determines whether a folder should be traversed. If this method returns true, {@link #includeFile} is called for
+     * Tests whether a folder should be traversed. If this method returns true, {@link #includeFile} is called for
      * each of the children of the folder, and each of the child folders is recursively traversed.
      * <p>
      * This method is called on a folder before {@link #includeFile} is called.
@@ -43,6 +43,24 @@ public interface FileSelector {
      * @param fileInfo the file or folder to select.
      * @return true if the folder should be traversed.
      * @throws Exception if an error occurs.
+     * @since 2.10.0
      */
+    default boolean traverseDescendants(FileSelectInfo fileInfo) throws Exception {
+        return traverseDescendents(fileInfo);
+    }
+
+    /**
+     * Tests whether a folder should be traversed. If this method returns true, {@link #includeFile} is called for
+     * each of the children of the folder, and each of the child folders is recursively traversed.
+     * <p>
+     * This method is called on a folder before {@link #includeFile} is called.
+     * </p>
+     *
+     * @param fileInfo the file or folder to select.
+     * @return true if the folder should be traversed.
+     * @throws Exception if an error occurs.
+     * @deprecated Use {@link #traverseDescendants(FileSelectInfo)}.
+     */
+    @Deprecated
     boolean traverseDescendents(FileSelectInfo fileInfo) throws Exception;
 }
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/InvertIncludeFileSelector.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/InvertIncludeFileSelector.java
index 30f4acd3..59054e47 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/InvertIncludeFileSelector.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/InvertIncludeFileSelector.java
@@ -49,7 +49,7 @@ public class InvertIncludeFileSelector implements FileSelector {
      */
     @Override
     public boolean traverseDescendents(final FileSelectInfo fileInfo) throws Exception {
-        return delegateFileSelector.traverseDescendents(fileInfo);
+        return delegateFileSelector.traverseDescendants(fileInfo);
     }
 
 }
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
index 856feca9..38005503 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
@@ -120,7 +120,7 @@ public abstract class AbstractFileObject<AFS extends AbstractFileSystem> impleme
         final int index = selected.size();
 
         // If the file is a folder, traverse it
-        if (file.getType().hasChildren() && selector.traverseDescendents(fileInfo)) {
+        if (file.getType().hasChildren() && selector.traverseDescendants(fileInfo)) {
             final int curDepth = fileInfo.getDepth();
             fileInfo.setDepth(curDepth + 1);