Package org.apache.groovy.antlr

Class GroovydocVisitor

java.lang.Object
org.codehaus.groovy.ast.CodeVisitorSupport
org.codehaus.groovy.ast.ClassCodeVisitorSupport
org.apache.groovy.antlr.GroovydocVisitor
All Implemented Interfaces:
org.codehaus.groovy.ast.GroovyClassVisitor, org.codehaus.groovy.ast.GroovyCodeVisitor, org.codehaus.groovy.transform.ErrorCollecting
public class GroovydocVisitor
extends org.codehaus.groovy.ast.ClassCodeVisitorSupport
A visitor which collects Groovydoc information.

  • Constructor Summary

    Constructors
    Constructor Description
    GroovydocVisitor​(org.codehaus.groovy.control.SourceUnit unit, java.lang.String packagePath, java.util.List<LinkArgument> links)  
    GroovydocVisitor​(org.codehaus.groovy.control.SourceUnit unit, java.lang.String packagePath, java.util.List<LinkArgument> links, java.util.Properties properties)  

  • Method Summary

    Modifier and Type Method Description
    java.util.Map<java.lang.String,​GroovyClassDoc> getGroovyClassDocs()  
    protected org.codehaus.groovy.control.SourceUnit getSourceUnit()  
    void visitClass​(org.codehaus.groovy.ast.ClassNode node)  
    void visitConstructor​(org.codehaus.groovy.ast.ConstructorNode node)  
    void visitDeclarationExpression​(org.codehaus.groovy.ast.expr.DeclarationExpression expression)  
    void visitField​(org.codehaus.groovy.ast.FieldNode node)  
    void visitMethod​(org.codehaus.groovy.ast.MethodNode node)  
    void visitProperty​(org.codehaus.groovy.ast.PropertyNode node)  

    Methods inherited from class org.codehaus.groovy.ast.ClassCodeVisitorSupport

    addError, visitAnnotation, visitAnnotations, visitAssertStatement, visitBlockStatement, visitBreakStatement, visitCaseStatement, visitCatchStatement, visitClassCodeContainer, visitConstructorOrMethod, visitContinueStatement, visitDoWhileLoop, visitExpressionStatement, visitForLoop, visitIfElse, visitImports, visitObjectInitializerStatements, visitPackage, visitReturnStatement, visitStatement, visitSwitch, visitSynchronizedStatement, visitThrowStatement, visitTryCatchFinally, visitWhileLoop

    Methods inherited from class org.codehaus.groovy.ast.CodeVisitorSupport

    afterSwitchConditionExpressionVisited, visitArgumentlistExpression, visitArrayExpression, visitAttributeExpression, visitBinaryExpression, visitBitwiseNegationExpression, visitBooleanExpression, visitBytecodeExpression, visitCastExpression, visitClassExpression, visitClosureExpression, visitClosureListExpression, visitConstantExpression, visitConstructorCallExpression, visitEmptyStatement, visitFieldExpression, visitGStringExpression, visitLambdaExpression, visitListExpression, visitMapEntryExpression, visitMapExpression, visitMethodCallExpression, visitMethodPointerExpression, visitMethodReferenceExpression, visitNotExpression, visitPostfixExpression, visitPrefixExpression, visitPropertyExpression, visitRangeExpression, visitShortTernaryExpression, visitSpreadExpression, visitSpreadMapExpression, visitStaticMethodCallExpression, visitTernaryExpression, visitTupleExpression, visitUnaryMinusExpression, visitUnaryPlusExpression, visitVariableExpression

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.codehaus.groovy.ast.GroovyCodeVisitor

    visitEmptyExpression, visitListOfExpressions

  • Constructor Details

    • GroovydocVisitor

      public GroovydocVisitor​(org.codehaus.groovy.control.SourceUnit unit, java.lang.String packagePath, java.util.List<LinkArgument> links)

    • GroovydocVisitor

      public GroovydocVisitor​(org.codehaus.groovy.control.SourceUnit unit, java.lang.String packagePath, java.util.List<LinkArgument> links, java.util.Properties properties)

  • Method Details

    • getSourceUnit

      protected org.codehaus.groovy.control.SourceUnit getSourceUnit()
      Specified by:
      getSourceUnit in class org.codehaus.groovy.ast.ClassCodeVisitorSupport

    • visitClass

      public void visitClass​(org.codehaus.groovy.ast.ClassNode node)
      Specified by:
      visitClass in interface org.codehaus.groovy.ast.GroovyClassVisitor
      Overrides:
      visitClass in class org.codehaus.groovy.ast.ClassCodeVisitorSupport

    • visitConstructor

      public void visitConstructor​(org.codehaus.groovy.ast.ConstructorNode node)
      Specified by:
      visitConstructor in interface org.codehaus.groovy.ast.GroovyClassVisitor
      Overrides:
      visitConstructor in class org.codehaus.groovy.ast.ClassCodeVisitorSupport

    • visitMethod

      public void visitMethod​(org.codehaus.groovy.ast.MethodNode node)
      Specified by:
      visitMethod in interface org.codehaus.groovy.ast.GroovyClassVisitor
      Overrides:
      visitMethod in class org.codehaus.groovy.ast.ClassCodeVisitorSupport

    • visitProperty

      public void visitProperty​(org.codehaus.groovy.ast.PropertyNode node)
      Specified by:
      visitProperty in interface org.codehaus.groovy.ast.GroovyClassVisitor
      Overrides:
      visitProperty in class org.codehaus.groovy.ast.ClassCodeVisitorSupport

    • visitDeclarationExpression

      public void visitDeclarationExpression​(org.codehaus.groovy.ast.expr.DeclarationExpression expression)
      Specified by:
      visitDeclarationExpression in interface org.codehaus.groovy.ast.GroovyCodeVisitor
      Overrides:
      visitDeclarationExpression in class org.codehaus.groovy.ast.ClassCodeVisitorSupport

    • visitField

      public void visitField​(org.codehaus.groovy.ast.FieldNode node)
      Specified by:
      visitField in interface org.codehaus.groovy.ast.GroovyClassVisitor
      Overrides:
      visitField in class org.codehaus.groovy.ast.ClassCodeVisitorSupport

    • getGroovyClassDocs

      public java.util.Map<java.lang.String,​GroovyClassDoc> getGroovyClassDocs()