You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2022/06/06 17:50:39 UTC

[maven-resolver] 09/10: Add javadoc

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

michaelo pushed a commit to branch tmp-collect-listener-2
in repository https://gitbox.apache.org/repos/asf/maven-resolver.git

commit bbbc03cf5b97bd693c1e054f4b5ae35537f8fb8a
Author: Tamas Cservenak <ta...@cservenak.net>
AuthorDate: Sun May 29 19:23:05 2022 +0200

    Add javadoc
---
 .../internal/impl/collect/DependencyCollectorDelegate.java | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/maven-resolver-impl/src/main/java/org/eclipse/aether/internal/impl/collect/DependencyCollectorDelegate.java b/maven-resolver-impl/src/main/java/org/eclipse/aether/internal/impl/collect/DependencyCollectorDelegate.java
index 1b5bf5ba..0897cc68 100644
--- a/maven-resolver-impl/src/main/java/org/eclipse/aether/internal/impl/collect/DependencyCollectorDelegate.java
+++ b/maven-resolver-impl/src/main/java/org/eclipse/aether/internal/impl/collect/DependencyCollectorDelegate.java
@@ -290,6 +290,20 @@ public abstract class DependencyCollectorDelegate implements DependencyCollector
         return result;
     }
 
+    /**
+     * Creates child {@link RequestTrace} instance from passed in {@link RequestTrace} and parameters by creating
+     * {@link CollectStepDataImpl} instance out of passed in data. Caller must ensure that passed in parameters are
+     * NOT affected by threading (or that there is no multi threading involved). In other words, the passed in values
+     * should be immutable.
+     *
+     * @param trace   The current trace instance.
+     * @param context The context from {@link CollectRequest#getRequestContext()}, never {@code null}.
+     * @param path    List representing the path of dependency nodes, never {@code null}. Caller must ensure, that this
+     *                list does not change during the lifetime of the requested {@link RequestTrace} instance. If it may
+     *                change, simplest is to pass here a copy of used list.
+     * @param node    Currently collected node, that collector came by following the passed in path.
+     * @return A child request trance instance, never {@code null}.
+     */
     protected RequestTrace collectStepTrace( RequestTrace trace, String context, List<DependencyNode> path,
                                              Dependency node )
     {