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