Module jdk.compiler

Class DocTreePathScanner<R,P>

  • All Implemented Interfaces:
    DocTreeVisitor<R,P>


    public class DocTreePathScanner<R,P>
    extends DocTreeScanner<R,P>
    A DocTreeVisitor that visits all the child tree nodes, and provides support for maintaining a path for the parent nodes. To visit nodes of a particular type, just override the corresponding visitorXYZ method. Inside your method, call super.visitXYZ to visit descendant nodes.
    Since:
    1.8
    • Constructor Detail

      • DocTreePathScanner

        public DocTreePathScanner​()
    • Method Detail

      • scan

        public R scan​(DocTreePath path,
                      P p)
        Scans a tree from a position identified by a tree path.
        Parameters:
        path - the path
        p - a value to be passed to visitor methods
        Returns:
        the result returned from the main visitor method
      • scan

        public R scan​(DocTree tree,
                      P p)
        Scans a single node. The current path is updated for the duration of the scan.
        Overrides:
        scan in class DocTreeScanner<R,P>
        Parameters:
        tree - the tree to be scanned
        p - a value to be passed to visitor methods
        Returns:
        the result returned from the main visitor method
      • getCurrentPath

        public DocTreePath getCurrentPath​()
        Returns the current path for the node, as built up by the currently active set of scan calls.
        Returns:
        the current path