1 package org.eclipse.aether.collection;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.util.List;
23
24 import org.eclipse.aether.graph.Dependency;
25 import org.eclipse.aether.graph.DependencyNode;
26
27 /**
28 * A trace data object revealing collect step (while executing {@link CollectRequest}.
29 *
30 * @see org.eclipse.aether.RequestTrace
31 * @since 1.8.1
32 * @noimplement This interface is not intended to be implemented by clients.
33 * @noextend This interface is not intended to be extended by clients.
34 */
35 public interface CollectStepData
36 {
37 /**
38 * Returns the context of collection. Never {@code null}.
39 */
40 String getContext();
41
42 /**
43 * Returns the path of dependency nodes that led collector to current node returned by {@link #getNode()}.
44 * Never {@code null}.
45 */
46 List<DependencyNode> getPath();
47
48 /**
49 * Returns the current node being collected. Never {@code null}.
50 */
51 Dependency getNode();
52 }