1 package org.apache.maven.shared.transfer.graph;
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.apache.maven.artifact.Artifact;
25 import org.apache.maven.artifact.repository.ArtifactRepository;
26
27 /**
28 * Represents a dependency node within a Maven project's dependency collector.
29 *
30 * @author Pim Moerenhout
31 * @since 0.12
32 */
33 public interface DependencyNode
34 {
35 /**
36 * Gets the child nodes of this node.
37 *
38 * @return the child nodes of this node, never {@code null}
39 */
40 List<DependencyNode> getChildren();
41
42 /**
43 * @return artifact for this DependencyCollectorNode
44 */
45 Artifact getArtifact();
46
47 /**
48 * @return repositories of this DependencyCollectorNode
49 */
50 List<ArtifactRepository> getRemoteRepositories();
51
52 /**
53 * @return true for an optional dependency.
54 */
55 Boolean getOptional();
56
57 /**
58 * @return The scope on the dependency.
59 */
60 String getScope();
61
62 /**
63 * Traverses this node and potentially its children using the specified visitor.
64 *
65 * @param visitor The visitor to call back, must not be {@code null}.
66 * @return {@code true} to visit siblings nodes of this node as well, {@code false} to skip siblings.
67 */
68 boolean accept( DependencyVisitor visitor );
69 }