This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-api.git
The following commit(s) were added to refs/heads/master by this push:
new 85a0694 improve the javadoc
85a0694 is described below
commit 85a0694ca48180480d03808e06d00ed6ff970fca
Author: Konrad Windszus <[email protected]>
AuthorDate: Wed Aug 29 12:56:35 2018 +0200
improve the javadoc
---
.../org/apache/sling/api/resource/AbstractResourceVisitor.java | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git
a/src/main/java/org/apache/sling/api/resource/AbstractResourceVisitor.java
b/src/main/java/org/apache/sling/api/resource/AbstractResourceVisitor.java
index 20f8fc3..e152a5f 100644
--- a/src/main/java/org/apache/sling/api/resource/AbstractResourceVisitor.java
+++ b/src/main/java/org/apache/sling/api/resource/AbstractResourceVisitor.java
@@ -23,11 +23,13 @@ import java.util.Iterator;
import org.jetbrains.annotations.NotNull;
/**
- * The <code>AbstractResourceVisitor</code> helps in traversing a
- * resource tree by decoupling the actual traversal code
- * from application code. Concrete subclasses should implement
- * the {@link AbstractResourceVisitor#visit(Resource)} method.
+ * This visitor will traverse the given resource and all its children in a
breadth-first approach
+ * and call the {@link AbstractResourceVisitor#visit(Resource)} method for
each visited resource.
+ * It decouples the actual traversal code from application code.
+ *
+ * Concrete subclasses must implement the {@link
AbstractResourceVisitor#visit(Resource)} method.
*
+ * @see <a
href="https://en.wikipedia.org/wiki/Breadth-first_search";>Breadth-First-Search</a>
* @since 2.2 (Sling API Bundle 2.2.0)
*/
public abstract class AbstractResourceVisitor {
