com.google.cloud.tools.opensource.dependencies

Class DependencyPath

java.lang.Object

com.google.cloud.tools.opensource.dependencies.DependencyPath

public final class DependencyPath
extends Object

A sequence of Maven artifacts and dependencies (scope and optional flag) in between.

When this represents a path from the root to a leaf of a dependency tree, the first artifact in the path is the root of the tree and the last artifact is the leaf. The sequence of dependencies explains why the leaf is included in the dependency tree.

The first node is null for the dependency trees generated for multiple artifacts by DependencyGraphBuilder.buildFullDependencyGraph(List); otherwise the root node is not null.

Constructor Summary

Constructors

Constructor and Description
DependencyPath(org.eclipse.aether.artifact.Artifact root)

Method Summary

Modifier and Type	Method and Description
DependencyPath	append(org.eclipse.aether.graph.Dependency dependency)
DependencyPath	concat(DependencyPath childPath)
boolean	equals(Object o)
org.eclipse.aether.artifact.Artifact	findExclusion(String groupId, String artifactId) Returns the artifact that declares an exclusion element specified for groupId and artifactId.
org.eclipse.aether.artifact.Artifact	get(int i) Returns the artifact at ith node in the path.
com.google.common.collect.ImmutableList<String>	getArtifactKeys() Returns the versionless coordinates of the artifacts in the path.
org.eclipse.aether.graph.Dependency	getDependency(int i) Returns the ith dependency.
org.eclipse.aether.artifact.Artifact	getLeaf() Returns the artifact at the end of the path.
int	hashCode()
int	size() Returns the length of the path.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DependencyPath

public DependencyPath(@Nullable
                      org.eclipse.aether.artifact.Artifact root)

Method Detail

append

public DependencyPath append(org.eclipse.aether.graph.Dependency dependency)

concat

public DependencyPath concat(DependencyPath childPath)

size

public int size()

Returns the length of the path.

getLeaf

public org.eclipse.aether.artifact.Artifact getLeaf()

Returns the artifact at the end of the path.

getArtifactKeys

public com.google.common.collect.ImmutableList<String> getArtifactKeys()

Returns the versionless coordinates of the artifacts in the path.

get

public org.eclipse.aether.artifact.Artifact get(int i)

Returns the artifact at ith node in the path. The 0th element is the root of the dependency tree.

getDependency

public org.eclipse.aether.graph.Dependency getDependency(int i)

Returns the ith dependency. As root is not a dependency, the 0th element is the dependency of the root in the path.

findExclusion

public org.eclipse.aether.artifact.Artifact findExclusion(String groupId,
                                                          String artifactId)

Returns the artifact that declares an exclusion element specified for groupId and artifactId. Null if the dependency path does not have such artifact.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object