Class CycleAwareDependencyGraphDumper

java.lang.Object

org.eclipse.aether.util.graph.visitor.DependencyGraphDumper

org.eclipse.aether.util.graph.visitor.CycleAwareDependencyGraphDumper

All Implemented Interfaces:

DependencyVisitor

public class CycleAwareDependencyGraphDumper
extends DependencyGraphDumper

A DependencyGraphDumper that is safe to use on a graph containing cycles: a dependency graph in FULL verbosity mode may contain nodes that (directly or transitively) depend on an ancestor of themselves, which makes the plain DependencyGraphDumper recurse forever. Wrapping it in TreeDependencyVisitor avoids the stack overflow but also hides every node that was already visited anywhere else in the graph, so a node reached a second time through a different path (a perfectly normal diamond dependency, not a cycle) is silently dropped from the output as well.

This dumper only checks the path from the root to the node currently being visited: a node is only treated as a cycle when it is already one of its own ancestors. Diamonds are still printed in full, and a true cycle is printed once, marked, with its subtree cut off instead of being recursed into.

Since:

2.0.25

Field Summary

Fields inherited from class DependencyGraphDumper

consumer, nodes

Constructor Summary

Constructors

Constructor	Description
CycleAwareDependencyGraphDumper(Consumer<String> consumer)	Creates instance with given consumer.
CycleAwareDependencyGraphDumper(Consumer<String> consumer, Collection<Function<DependencyNode, String>> decorators)	Creates instance with given consumer and decorators.

Method Summary

Modifier and Type	Method	Description
boolean	visitEnter(DependencyNode node)	Notifies the visitor of a node visit before its children have been processed.

Methods inherited from class DependencyGraphDumper

artifactProperties, defaultsWith, effectiveDependency, formatIndentation, formatLine, formatNode, premanagedExclusions, premanagedOptional, premanagedProperties, premanagedScope, premanagedVersion, rangeMember, visitLeave, winnerNode

Methods inherited from class Object

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

Constructor Details

CycleAwareDependencyGraphDumper

public CycleAwareDependencyGraphDumper(Consumer<String> consumer)

Creates instance with given consumer.

Parameters:

consumer - the string consumer, must not be null

CycleAwareDependencyGraphDumper

public CycleAwareDependencyGraphDumper(Consumer<String> consumer,
 Collection<Function<DependencyNode, String>> decorators)

Creates instance with given consumer and decorators.

Parameters:

consumer - the string consumer, must not be null

decorators - the decorators to apply, must not be null

Method Details

visitEnter

public boolean visitEnter(DependencyNode node)

Description copied from interface: DependencyVisitor

Notifies the visitor of a node visit before its children have been processed.

Specified by:

visitEnter in interface DependencyVisitor

Overrides:

visitEnter in class DependencyGraphDumper

Parameters:

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

Returns:

true to visit child nodes of the specified node as well, false to skip children.