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

Class DependencyGraphDumper

  • All Implemented Interfaces:
    org.eclipse.aether.graph.DependencyVisitor
    public class DependencyGraphDumper
extends java.lang.Object
implements org.eclipse.aether.graph.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​(java.util.function.Consumer<java.lang.String> consumer)
      Creates instance with given consumer.
      DependencyGraphDumper​(java.util.function.Consumer<java.lang.String> consumer, java.util.Collection<java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String>> decorators)
      Creates instance with given consumer and decorators.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> artifactProperties​(java.util.Collection<java.lang.String> properties)
      Decorator of "artifact properties": prints out asked properties, if present.
      static java.util.List<java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String>> defaultsWith​(java.util.Collection<java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String>> extras)
      Extends DEFAULT_DECORATORS decorators with passed in ones.
      static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> effectiveDependency()
      Decorator of "effective dependency": shows effective scope and optionality.
      protected java.lang.String formatIndentation​(java.util.Deque<org.eclipse.aether.graph.DependencyNode> nodes)  
      protected java.lang.String formatLine​(java.util.Deque<org.eclipse.aether.graph.DependencyNode> nodes)  
      protected java.lang.String formatNode​(java.util.Deque<org.eclipse.aether.graph.DependencyNode> nodes)  
      static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> premanagedExclusions()
      Decorator of "managed exclusions": explains on nodes what was managed.
      static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> premanagedOptional()
      Decorator of "managed optionality": explains on nodes what was managed.
      static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> premanagedProperties()
      Decorator of "managed properties": explains on nodes what was managed.
      static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> premanagedScope()
      Decorator of "managed scope": explains on nodes what was managed.
      static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> premanagedVersion()
      Decorator of "managed version": explains on nodes what was managed.
      static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> rangeMember()
      Decorator of "range member": explains on nodes what range it participates in.
      boolean visitEnter​(org.eclipse.aether.graph.DependencyNode node)  
      boolean visitLeave​(org.eclipse.aether.graph.DependencyNode node)  
      static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.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 Detail

      • DependencyGraphDumper

        public DependencyGraphDumper​(java.util.function.Consumer<java.lang.String> consumer)
        Creates instance with given consumer.
        Parameters:
        consumer - the string consumer, must not be null

      • DependencyGraphDumper

        public DependencyGraphDumper​(java.util.function.Consumer<java.lang.String> consumer,
                             java.util.Collection<java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.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 Detail

      • effectiveDependency

        public static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> effectiveDependency()
        Decorator of "effective dependency": shows effective scope and optionality.

      • premanagedVersion

        public static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> premanagedVersion()
        Decorator of "managed version": explains on nodes what was managed.

      • premanagedScope

        public static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> premanagedScope()
        Decorator of "managed scope": explains on nodes what was managed.

      • premanagedOptional

        public static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> premanagedOptional()
        Decorator of "managed optionality": explains on nodes what was managed.

      • premanagedExclusions

        public static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> premanagedExclusions()
        Decorator of "managed exclusions": explains on nodes what was managed.

      • premanagedProperties

        public static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> premanagedProperties()
        Decorator of "managed properties": explains on nodes what was managed.

      • rangeMember

        public static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> rangeMember()
        Decorator of "range member": explains on nodes what range it participates in.

      • winnerNode

        public static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> winnerNode()
        Decorator of "winner node": explains on losers why lost.

      • artifactProperties

        public static java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String> artifactProperties​(java.util.Collection<java.lang.String> properties)
        Decorator of "artifact properties": prints out asked properties, if present.

      • defaultsWith

        public static java.util.List<java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String>> defaultsWith​(java.util.Collection<java.util.function.Function<org.eclipse.aether.graph.DependencyNode,​java.lang.String>> extras)
        Extends DEFAULT_DECORATORS decorators with passed in ones.
        Since:
        2.0.0

      • visitEnter

        public boolean visitEnter​(org.eclipse.aether.graph.DependencyNode node)
        Specified by:
        visitEnter in interface org.eclipse.aether.graph.DependencyVisitor

      • visitLeave

        public boolean visitLeave​(org.eclipse.aether.graph.DependencyNode node)
        Specified by:
        visitLeave in interface org.eclipse.aether.graph.DependencyVisitor

      • formatLine

        protected java.lang.String formatLine​(java.util.Deque<org.eclipse.aether.graph.DependencyNode> nodes)

      • formatIndentation

        protected java.lang.String formatIndentation​(java.util.Deque<org.eclipse.aether.graph.DependencyNode> nodes)

      • formatNode

        protected java.lang.String formatNode​(java.util.Deque<org.eclipse.aether.graph.DependencyNode> nodes)