Package org.eclipse.aether.util.graph.visitor

Class NodeListGenerator

java.lang.Object

org.eclipse.aether.util.graph.visitor.NodeListGenerator

All Implemented Interfaces:

Consumer<DependencyNode>

public final class NodeListGenerator
extends Object
implements Consumer<DependencyNode>

Node list generator usable with different traversing strategies. It is wrapped List<DependencyNode> but offers several transformations, that are handy.

Since:

2.0.0

See Also:

• PreorderDependencyNodeConsumerVisitor
• PostorderDependencyNodeConsumerVisitor
• LevelOrderDependencyNodeConsumerVisitor

Constructor Summary

Constructors

Constructor	Description
NodeListGenerator()

Method Summary

Modifier and Type	Method	Description
void	accept(DependencyNode dependencyNode)
List<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<Dependency>	getDependencies(boolean includeUnresolved)	Gets the dependencies seen during the graph traversal.
List<File>	getFiles()	Deprecated. Use getPaths() instead.
List<DependencyNode>	getNodes()	Gets the list of dependency nodes that was generated during the graph traversal.
List<DependencyNode>	getNodesWithDependencies()	Gets the list of dependency nodes that was generated during the graph traversal and have non-null DependencyNode.getDependency().
List<Path>	getPaths()	Gets the files of resolved artifacts seen during the graph traversal.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Details

NodeListGenerator

public NodeListGenerator()

Method Details

accept

public void accept(DependencyNode dependencyNode)

Specified by:

accept in interface Consumer<DependencyNode>

getNodes

public List<DependencyNode> getNodes()

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

Returns:

The list of dependency nodes, never null.

getNodesWithDependencies

public List<DependencyNode> getNodesWithDependencies()

Gets the list of dependency nodes that was generated during the graph traversal and have non-null DependencyNode.getDependency().

Returns:

The list of dependency nodes having dependency, never null.

getDependencies

public List<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<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

@Deprecated
public List<File> getFiles()

Deprecated.

Use getPaths() instead.

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

Returns:

The list of artifact files, never null.

getPaths

public List<Path> getPaths()

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

Returns:

The list of artifact files, never null.

Since:

2.0.0

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.