org.nuxeo.build.maven.graph

Class AbstractDependencyVisitor

java.lang.Object

org.nuxeo.build.maven.graph.AbstractDependencyVisitor

All Implemented Interfaces:

org.eclipse.aether.graph.DependencyVisitor

Direct Known Subclasses:

FlatPrinterDependencyVisitor, TreePrinterDependencyVisitor

public abstract class AbstractDependencyVisitor
extends Object
implements org.eclipse.aether.graph.DependencyVisitor

Prints the graph while traversing it. Do not print nodes provided through addIgnores(Collection). Inspired from AbstractDepthFirstNodeListGenerator

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.eclipse.aether.graph.DependencyNode>	ignores
protected Map<String,org.eclipse.aether.graph.DependencyNode>	nodesMap
protected List<String>	scopes

Constructor Summary

Constructors

Constructor and Description
AbstractDependencyVisitor(List<String> scopes)

Method Summary

Methods

Modifier and Type	Method and Description
void	addIgnores(Collection<? extends org.eclipse.aether.graph.DependencyNode> nodesToIgnore)
protected abstract void	doVisit(org.eclipse.aether.graph.DependencyNode node, boolean newNode) Actions to perform when visiting a node.
List<org.eclipse.aether.artifact.Artifact>	getArtifacts(boolean includeUnresolved) Gets the artifacts associated with the list of dependency nodes generated during the graph traversal.
String	getClassPath() Gets a class path by concatenating the artifact files of the visited dependency nodes.
List<org.eclipse.aether.graph.Dependency>	getDependencies(boolean includeUnresolved) Gets the dependencies seen during the graph traversal.
List<File>	getFiles() Gets the files of resolved artifacts seen during the graph traversal.
Collection<org.eclipse.aether.graph.DependencyNode>	getNodes() Gets the list of dependency nodes that was generated during the graph traversal.
protected boolean	setVisited(org.eclipse.aether.graph.DependencyNode node) Marks the specified node as being visited and determines whether the node has been visited before.
boolean	visitEnter(org.eclipse.aether.graph.DependencyNode node)
boolean	visitLeave(org.eclipse.aether.graph.DependencyNode node) Note that method is always called, even if doVisit(DependencyNode, boolean) was not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nodesMap

protected final Map<String,org.eclipse.aether.graph.DependencyNode> nodesMap

ignores

protected final List<org.eclipse.aether.graph.DependencyNode> ignores

scopes

protected List<String> scopes

Constructor Detail

AbstractDependencyVisitor

public AbstractDependencyVisitor(List<String> scopes)

Parameters:

scopes - Included scopes (if null, all scopes are included).

Method Detail

getNodes

public Collection<org.eclipse.aether.graph.DependencyNode> getNodes()

Gets the list of dependency nodes that was generated during the graph traversal.

Returns:

The list of dependency nodes, never null.

addIgnores

public void addIgnores(Collection<? extends org.eclipse.aether.graph.DependencyNode> nodesToIgnore)

Parameters:

nodesToIgnore - Nodes to ignore during the visit

setVisited

protected boolean setVisited(org.eclipse.aether.graph.DependencyNode node)

Marks the specified node as being visited and determines whether the node has been visited before.

Parameters:

node - The node being visited, must not be null.

Returns:

true if the node has not been visited before, false if the node was already visited.

visitEnter

public boolean visitEnter(org.eclipse.aether.graph.DependencyNode node)

Specified by:

visitEnter in interface org.eclipse.aether.graph.DependencyVisitor

doVisit

protected abstract void doVisit(org.eclipse.aether.graph.DependencyNode node,
           boolean newNode)

Actions to perform when visiting a node. The method is not called if the node was "ignored" (ie included in ignores.

Parameters:

newNode - True if visiting the node for the first time

visitLeave

public boolean visitLeave(org.eclipse.aether.graph.DependencyNode node)

Note that method is always called, even if doVisit(DependencyNode, boolean) was not. Check ignores if needed.

Specified by:

visitLeave in interface org.eclipse.aether.graph.DependencyVisitor

getDependencies

public List<org.eclipse.aether.graph.Dependency> getDependencies(boolean includeUnresolved)

Gets the dependencies seen during the graph traversal.

Parameters:

includeUnresolved - Whether unresolved dependencies shall be included in the result or not.

Returns:

The list of dependencies, never null.

getArtifacts

public List<org.eclipse.aether.artifact.Artifact> getArtifacts(boolean includeUnresolved)

Gets the artifacts associated with the list of dependency nodes generated during the graph traversal.

Parameters:

includeUnresolved - Whether unresolved artifacts shall be included in the result or not.

Returns:

The list of artifacts, never null.

getFiles

public List<File> getFiles()

Gets the files of resolved artifacts seen during the graph traversal.

Returns:

The list of artifact files, never null.

getClassPath

public String getClassPath()

Gets a class path by concatenating the artifact files of the visited dependency nodes. Nodes with unresolved artifacts are automatically skipped.

Returns:

The class path, using the platform-specific path separator, never null.