fixup! add support to traverse JavaType signature

Review: Extend Javadoc to explain that the traversal happens depth first. Signed-off-by: Peter Gafert <[email protected]>
TNG · Apr 7, 2024 · 07bf2cd · 07bf2cd
1 parent 44cf60c
commit 07bf2cd
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/archunit/src/main/java/com/tngtech/archunit/core/domain/JavaType.java b/archunit/src/main/java/com/tngtech/archunit/core/domain/JavaType.java
@@ -128,7 +128,9 @@ public Result visitParameterizedType(JavaParameterizedType type) {
  * Serializable String
  * </code></pre>
  * For every node visited the respective method of the provided {@code visitor}
- * will be invoked. At every step it is possible to continue the traversal
+ * will be invoked. The traversal happens depth first, i.e. in this case the {@code visitor}
+ * would be invoked for all types down to {@code Serializable} before visiting the {@code String[]}
+ * array type of the second branch. At every step it is possible to continue the traversal
  * by returning {@link SignatureVisitor.Result#CONTINUE CONTINUE} or stop at that point by
  * returning {@link SignatureVisitor.Result#STOP STOP}.<br><br>
  * Note that the traversal will continue to traverse bounds of type variables,