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 9e31b30 fix typo in javadoc and link to
ResourceStream/ResourceFilterStream
new c19b9e4 Merge branch 'master' of
[email protected]:apache/sling-org-apache-sling-api.git
9e31b30 is described below
commit 9e31b3074e6ee6a7ca665e8c34f4909a9e2a26b4
Author: Konrad Windszus <[email protected]>
AuthorDate: Mon Jul 15 11:01:51 2019 +0200
fix typo in javadoc and link to ResourceStream/ResourceFilterStream
---
pom.xml | 8 +++++++-
.../org/apache/sling/api/resource/AbstractResourceVisitor.java | 8 ++++++--
2 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/pom.xml b/pom.xml
index a73aa75..6579879 100644
--- a/pom.xml
+++ b/pom.xml
@@ -114,8 +114,14 @@
<version>1.0.0</version>
<scope>provided</scope>
</dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.resource.filter</artifactId>
+ <version>1.0.0</version>
+ <scope>provided</scope> <!-- just used for javadoc link -->
+ </dependency>
</dependencies>
-
+
<build>
<plugins>
<!-- Create the bundle of the Sling API -->
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 e152a5f..1d7ba0e 100644
--- a/src/main/java/org/apache/sling/api/resource/AbstractResourceVisitor.java
+++ b/src/main/java/org/apache/sling/api/resource/AbstractResourceVisitor.java
@@ -23,13 +23,17 @@ import java.util.Iterator;
import org.jetbrains.annotations.NotNull;
/**
- * This visitor will traverse the given resource and all its children in a
breadth-first approach
+ * This visitor will traverse the given resource and all its children in a
depth-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.
+ * There is no possibility to stop traversal in this visitor. If you want to
skip certain
+ * parts of the subtree or stop traversal at a certain point rather use
+ * {@link org.apache.sling.resource.filter.ResourceStream} or
+ * {@link org.apache.sling.resource.filter.ResourceFilterStream}.
*
- * @see <a
href="https://en.wikipedia.org/wiki/Breadth-first_search";>Breadth-First-Search</a>
+ * @see <a
href="https://en.wikipedia.org/wiki/Depth-first_search";>Depth-First-Search</a>
* @since 2.2 (Sling API Bundle 2.2.0)
*/
public abstract class AbstractResourceVisitor {
