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

Class DependencyGraphDumper

java.lang.Object

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

All Implemented Interfaces:

DependencyVisitor

public class DependencyGraphDumper
extends Object
implements DependencyVisitor

A dependency visitor that dumps the graph to any Consumer<String>. Meant for diagnostic and testing, as it may output the graph to standard output, error or even some logging interface.

Since:

1.9.8

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static Function<DependencyNode,String>	artifactProperties(Collection<String> properties)	Decorator of "artifact properties": prints out asked properties, if present.
static List<Function<DependencyNode,String>>	defaultsWith(Collection<Function<DependencyNode,String>> extras)	Extends DEFAULT_DECORATORS decorators with passed in ones.
static Function<DependencyNode,String>	effectiveDependency()	Decorator of "effective dependency": shows effective scope and optionality.
protected String	formatIndentation(Deque<DependencyNode> nodes)
protected String	formatLine(Deque<DependencyNode> nodes)
protected String	formatNode(Deque<DependencyNode> nodes)
static Function<DependencyNode,String>	premanagedExclusions()	Decorator of "managed exclusions": explains on nodes what was managed.
static Function<DependencyNode,String>	premanagedOptional()	Decorator of "managed optionality": explains on nodes what was managed.
static Function<DependencyNode,String>	premanagedProperties()	Decorator of "managed properties": explains on nodes what was managed.
static Function<DependencyNode,String>	premanagedScope()	Decorator of "managed scope": explains on nodes what was managed.
static Function<DependencyNode,String>	premanagedVersion()	Decorator of "managed version": explains on nodes what was managed.
static Function<DependencyNode,String>	rangeMember()	Decorator of "range member": explains on nodes what range it participates in.
boolean	visitEnter(DependencyNode node)	Notifies the visitor of a node visit before its children have been processed.
boolean	visitLeave(DependencyNode node)	Notifies the visitor of a node visit after its children have been processed.
static Function<DependencyNode,String>	winnerNode()	Decorator of "winner node": explains on losers why lost.

Methods inherited from class java.lang.Object

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

Constructor Details

DependencyGraphDumper

public DependencyGraphDumper(Consumer<String> consumer)

Creates instance with given consumer.

Parameters:

consumer - The string consumer, must not be null.

DependencyGraphDumper

public DependencyGraphDumper(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.

Since:

2.0.0

Method Details

effectiveDependency

public static Function<DependencyNode,String> effectiveDependency()

Decorator of "effective dependency": shows effective scope and optionality.

premanagedVersion

public static Function<DependencyNode,String> premanagedVersion()

Decorator of "managed version": explains on nodes what was managed.

premanagedScope

public static Function<DependencyNode,String> premanagedScope()

Decorator of "managed scope": explains on nodes what was managed.

premanagedOptional

public static Function<DependencyNode,String> premanagedOptional()

Decorator of "managed optionality": explains on nodes what was managed.

premanagedExclusions

public static Function<DependencyNode,String> premanagedExclusions()

Decorator of "managed exclusions": explains on nodes what was managed.

premanagedProperties

public static Function<DependencyNode,String> premanagedProperties()

Decorator of "managed properties": explains on nodes what was managed.

rangeMember

public static Function<DependencyNode,String> rangeMember()

Decorator of "range member": explains on nodes what range it participates in.

winnerNode

public static Function<DependencyNode,String> winnerNode()

Decorator of "winner node": explains on losers why lost.

artifactProperties

public static Function<DependencyNode,String> artifactProperties(Collection<String> properties)

Decorator of "artifact properties": prints out asked properties, if present.

defaultsWith

public static List<Function<DependencyNode,String>> defaultsWith(Collection<Function<DependencyNode,String>> extras)

Extends DEFAULT_DECORATORS decorators with passed in ones.

Since:

2.0.0

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

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.

visitLeave

public boolean visitLeave(DependencyNode node)

Description copied from interface: DependencyVisitor

Notifies the visitor of a node visit after its children have been processed. Note that this method is always invoked regardless whether any children have actually been visited.

Specified by:

visitLeave in interface DependencyVisitor

Parameters:

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

Returns:

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

formatLine

protected String formatLine(Deque<DependencyNode> nodes)

formatIndentation

protected String formatIndentation(Deque<DependencyNode> nodes)

formatNode

protected String formatNode(Deque<DependencyNode> nodes)