Class AbstractAstVisitor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addViolation​(org.codehaus.groovy.ast.ASTNode node, java.lang.String message)
      Add a new Violation to the list of violations found by this visitor.
      protected void addViolation​(Violation violation)
      Add a new Violation to the list of violations found by this visitor.
      protected java.lang.String getCurrentClassName()  
      protected org.codehaus.groovy.ast.ClassNode getCurrentClassNode()  
      Rule getRule()  
      SourceCode getSourceCode()  
      protected org.codehaus.groovy.control.SourceUnit getSourceUnit()  
      java.util.List<Violation> getViolations()  
      java.util.Set<java.lang.Object> getVisited()  
      protected boolean isFirstVisit​(java.lang.Object expression)
      Return true if the AST expression has not already been visited.
      protected java.lang.String lastSourceLine​(org.codehaus.groovy.ast.ASTNode node)
      Return the last raw source line corresponding to the specified AST node
      protected java.lang.String lastSourceLineTrimmed​(org.codehaus.groovy.ast.ASTNode node)
      Return the trimmed last source line corresponding to the specified AST node
      void setRule​(Rule rule)  
      void setSourceCode​(SourceCode sourceCode)  
      void setVisited​(java.util.Set<java.lang.Object> visited)  
      protected boolean shouldVisitMethod​(org.codehaus.groovy.ast.MethodNode node)  
      protected java.lang.String sourceLine​(org.codehaus.groovy.ast.ASTNode node)
      Return the raw source line corresponding to the specified AST node
      protected java.lang.String sourceLineTrimmed​(org.codehaus.groovy.ast.ASTNode node)
      Return the trimmed source line corresponding to the specified AST node
      void visitClass​(org.codehaus.groovy.ast.ClassNode node)  
      protected void visitClassComplete​(org.codehaus.groovy.ast.ClassNode node)  
      protected void visitClassEx​(org.codehaus.groovy.ast.ClassNode node)  
      void visitMethod​(org.codehaus.groovy.ast.MethodNode node)  
      protected void visitMethodComplete​(org.codehaus.groovy.ast.MethodNode node)  
      protected void visitMethodEx​(org.codehaus.groovy.ast.MethodNode node)  
      • Methods inherited from class org.codehaus.groovy.ast.ClassCodeVisitorSupport

        addError, visitAnnotations, visitAssertStatement, visitBlockStatement, visitBreakStatement, visitCaseStatement, visitCatchStatement, visitClassCodeContainer, visitConstructor, visitConstructorOrMethod, visitContinueStatement, visitDeclarationExpression, visitDoWhileLoop, visitExpressionStatement, visitField, visitForLoop, visitIfElse, visitImports, visitObjectInitializerStatements, visitPackage, visitProperty, visitReturnStatement, visitStatement, visitSwitch, visitSynchronizedStatement, visitThrowStatement, visitTryCatchFinally, visitWhileLoop
      • Methods inherited from class org.codehaus.groovy.ast.CodeVisitorSupport

        visitArgumentlistExpression, visitArrayExpression, visitAttributeExpression, visitBinaryExpression, visitBitwiseNegationExpression, visitBooleanExpression, visitBytecodeExpression, visitCastExpression, visitClassExpression, visitClosureExpression, visitClosureListExpression, visitConstantExpression, visitConstructorCallExpression, visitEmptyStatement, visitFieldExpression, visitGStringExpression, visitListExpression, visitListOfExpressions, visitMapEntryExpression, visitMapExpression, visitMethodCallExpression, visitMethodPointerExpression, 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.GroovyClassVisitor

        visitConstructor, visitField, visitProperty
    • Field Detail

      • violations

        private final java.util.List<Violation> violations
      • rule

        private Rule rule
      • visited

        private java.util.Set<java.lang.Object> visited
      • currentClassNode

        private org.codehaus.groovy.ast.ClassNode currentClassNode
    • Constructor Detail

      • AbstractAstVisitor

        public AbstractAstVisitor()
    • Method Detail

      • isFirstVisit

        protected boolean isFirstVisit​(java.lang.Object expression)
        Return true if the AST expression has not already been visited. If it is the first visit, register the expression so that the next visit will return false.
        Parameters:
        expression - - the AST expression to check
        Returns:
        true if the AST expression has NOT already been visited
      • sourceLineTrimmed

        protected java.lang.String sourceLineTrimmed​(org.codehaus.groovy.ast.ASTNode node)
        Return the trimmed source line corresponding to the specified AST node
        Parameters:
        node - - the Groovy AST node
      • sourceLine

        protected java.lang.String sourceLine​(org.codehaus.groovy.ast.ASTNode node)
        Return the raw source line corresponding to the specified AST node
        Parameters:
        node - - the Groovy AST node
      • lastSourceLine

        protected java.lang.String lastSourceLine​(org.codehaus.groovy.ast.ASTNode node)
        Return the last raw source line corresponding to the specified AST node
        Parameters:
        node - - the Groovy AST node
      • lastSourceLineTrimmed

        protected java.lang.String lastSourceLineTrimmed​(org.codehaus.groovy.ast.ASTNode node)
        Return the trimmed last source line corresponding to the specified AST node
        Parameters:
        node - - the Groovy AST node
      • addViolation

        protected void addViolation​(org.codehaus.groovy.ast.ASTNode node,
                                    java.lang.String message)
        Add a new Violation to the list of violations found by this visitor. Only add the violation if the node lineNumber >= 0.
        Parameters:
        node - - the Groovy AST Node
        message - - the message for the violation; defaults to null
      • addViolation

        protected void addViolation​(Violation violation)
        Add a new Violation to the list of violations found by this visitor.
        Parameters:
        violation - - the violation to add
      • getSourceUnit

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

        public final 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
      • visitClassEx

        protected void visitClassEx​(org.codehaus.groovy.ast.ClassNode node)
      • visitClassComplete

        protected void visitClassComplete​(org.codehaus.groovy.ast.ClassNode node)
      • visitMethod

        public final 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
      • shouldVisitMethod

        protected boolean shouldVisitMethod​(org.codehaus.groovy.ast.MethodNode node)
      • visitMethodComplete

        protected void visitMethodComplete​(org.codehaus.groovy.ast.MethodNode node)
      • visitMethodEx

        protected void visitMethodEx​(org.codehaus.groovy.ast.MethodNode node)
      • getVisited

        public java.util.Set<java.lang.Object> getVisited()
      • getRule

        public Rule getRule()
      • getSourceCode

        public SourceCode getSourceCode()
      • setVisited

        public void setVisited​(java.util.Set<java.lang.Object> visited)
      • getCurrentClassName

        protected java.lang.String getCurrentClassName()
      • getCurrentClassNode

        protected org.codehaus.groovy.ast.ClassNode getCurrentClassNode()