public class AbstractFieldVisitor extends org.codehaus.groovy.ast.ClassCodeVisitorSupport implements AstVisitor
This is the base class for AST Visitors that only need to visit the fields of
a class. It will not visit anything except the FieldNode. It is much faster than
the alternative of visiting the whole class.
When you override visitField(FieldNode), there is no need to invoke the super method.
| Type Params | Return Type | Name and description |
|---|---|---|
|
public final void |
addError(java.lang.String msg, org.codehaus.groovy.ast.ASTNode expr) |
|
protected void |
addViolation(org.codehaus.groovy.ast.FieldNode node, java.lang.String message)Add a new Violation to the list of violations found by this visitor. |
|
public int |
compare(org.codehaus.groovy.ast.FieldNode o1, org.codehaus.groovy.ast.FieldNode o2) |
|
public Rule |
getRule()Gets the rule for this visitor. |
|
protected SourceCode |
getSourceCode() |
|
protected final org.codehaus.groovy.control.SourceUnit |
getSourceUnit() |
|
public java.util.List<Violation> |
getViolations()Retrieve the List of Violations resulting from applying this visitor |
|
public void |
setRule(Rule rule)Set the Rule associated with this visitor |
|
public void |
setSourceCode(SourceCode sourceCode)Set the SourceCode associated with this visitor |
|
public final void |
visitAnnotations(org.codehaus.groovy.ast.AnnotatedNode node) |
|
public final void |
visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression ale) |
|
public final void |
visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression expression) |
|
public final void |
visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement statement) |
|
public final void |
visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression expression) |
|
public final void |
visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression expression) |
|
public final void |
visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression expression) |
|
public final void |
visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement block) |
|
public final void |
visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression expression) |
|
public final void |
visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement statement) |
|
public final void |
visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression cle) |
|
public final void |
visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement statement) |
|
public final void |
visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression expression) |
|
public final void |
visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement statement) |
|
public void |
visitClass(org.codehaus.groovy.ast.ClassNode node) |
|
protected final void |
visitClassCodeContainer(org.codehaus.groovy.ast.stmt.Statement code) |
|
public final void |
visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression expression) |
|
public final void |
visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression expression) |
|
public final void |
visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression cle) |
|
public final void |
visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression expression) |
|
public final void |
visitConstructor(org.codehaus.groovy.ast.ConstructorNode node) |
|
public final void |
visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression call) |
|
protected final void |
visitConstructorOrMethod(org.codehaus.groovy.ast.MethodNode node, boolean isConstructor) |
|
public final void |
visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement statement) |
|
public final void |
visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression expression) |
|
public final void |
visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement loop) |
|
public final void |
visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement statement) |
|
public final void |
visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement statement) |
|
public final void |
visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression expression) |
|
public final void |
visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement forLoop) |
|
public final void |
visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression expression) |
|
public final void |
visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement ifElse) |
|
public final void |
visitImports(org.codehaus.groovy.ast.ModuleNode node) |
|
public final void |
visitListExpression(org.codehaus.groovy.ast.expr.ListExpression expression) |
|
public final void |
visitListOfExpressions(java.util.List<? extends org.codehaus.groovy.ast.expr.Expression> list) |
|
public final void |
visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression expression) |
|
public final void |
visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression expression) |
|
public final void |
visitMethod(org.codehaus.groovy.ast.MethodNode node) |
|
public final void |
visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression call) |
|
public final void |
visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression expression) |
|
public final void |
visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression expression) |
|
protected final void |
visitObjectInitializerStatements(org.codehaus.groovy.ast.ClassNode node) |
|
public final void |
visitPackage(org.codehaus.groovy.ast.PackageNode node) |
|
public final void |
visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression expression) |
|
public final void |
visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression expression) |
|
public final void |
visitProperty(org.codehaus.groovy.ast.PropertyNode node) |
|
public final void |
visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression expression) |
|
public final void |
visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression expression) |
|
public final void |
visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement statement) |
|
public final void |
visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression expression) |
|
public final void |
visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression expression) |
|
public final void |
visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression expression) |
|
protected final void |
visitStatement(org.codehaus.groovy.ast.stmt.Statement statement) |
|
public final void |
visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression call) |
|
public final void |
visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement statement) |
|
public final void |
visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement statement) |
|
public final void |
visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression expression) |
|
public final void |
visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement statement) |
|
public final void |
visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement statement) |
|
public final void |
visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression expression) |
|
public final void |
visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression expression) |
|
public final void |
visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression expression) |
|
public final void |
visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression expression) |
|
public final void |
visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement loop) |
| Methods inherited from class | Name |
|---|---|
class org.codehaus.groovy.ast.ClassCodeVisitorSupport |
org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitMethod(org.codehaus.groovy.ast.MethodNode), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitField(org.codehaus.groovy.ast.FieldNode), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitPackage(org.codehaus.groovy.ast.PackageNode), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitProperty(org.codehaus.groovy.ast.PropertyNode), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitClass(org.codehaus.groovy.ast.ClassNode), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitConstructor(org.codehaus.groovy.ast.ConstructorNode), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitReturnStatement(org.codehaus.groovy.ast.stmt.ReturnStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitAnnotations(org.codehaus.groovy.ast.AnnotatedNode), org.codehaus.groovy.ast.ClassCodeVisitorSupport#addError(java.lang.String, org.codehaus.groovy.ast.ASTNode), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitCatchStatement(org.codehaus.groovy.ast.stmt.CatchStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitForLoop(org.codehaus.groovy.ast.stmt.ForStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitBlockStatement(org.codehaus.groovy.ast.stmt.BlockStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitAssertStatement(org.codehaus.groovy.ast.stmt.AssertStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitCaseStatement(org.codehaus.groovy.ast.stmt.CaseStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitExpressionStatement(org.codehaus.groovy.ast.stmt.ExpressionStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitIfElse(org.codehaus.groovy.ast.stmt.IfStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitSwitch(org.codehaus.groovy.ast.stmt.SwitchStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitSynchronizedStatement(org.codehaus.groovy.ast.stmt.SynchronizedStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitThrowStatement(org.codehaus.groovy.ast.stmt.ThrowStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitWhileLoop(org.codehaus.groovy.ast.stmt.WhileStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitImports(org.codehaus.groovy.ast.ModuleNode), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitDeclarationExpression(org.codehaus.groovy.ast.expr.DeclarationExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitBreakStatement(org.codehaus.groovy.ast.stmt.BreakStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitContinueStatement(org.codehaus.groovy.ast.stmt.ContinueStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitTryCatchFinally(org.codehaus.groovy.ast.stmt.TryCatchStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitDoWhileLoop(org.codehaus.groovy.ast.stmt.DoWhileStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitListExpression(org.codehaus.groovy.ast.expr.ListExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitClassExpression(org.codehaus.groovy.ast.expr.ClassExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitPropertyExpression(org.codehaus.groovy.ast.expr.PropertyExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitConstantExpression(org.codehaus.groovy.ast.expr.ConstantExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitEmptyStatement(org.codehaus.groovy.ast.stmt.EmptyStatement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitMethodCallExpression(org.codehaus.groovy.ast.expr.MethodCallExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitStaticMethodCallExpression(org.codehaus.groovy.ast.expr.StaticMethodCallExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitConstructorCallExpression(org.codehaus.groovy.ast.expr.ConstructorCallExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitBinaryExpression(org.codehaus.groovy.ast.expr.BinaryExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitTernaryExpression(org.codehaus.groovy.ast.expr.TernaryExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitShortTernaryExpression(org.codehaus.groovy.ast.expr.ElvisOperatorExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitPostfixExpression(org.codehaus.groovy.ast.expr.PostfixExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitPrefixExpression(org.codehaus.groovy.ast.expr.PrefixExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitBooleanExpression(org.codehaus.groovy.ast.expr.BooleanExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitNotExpression(org.codehaus.groovy.ast.expr.NotExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitClosureExpression(org.codehaus.groovy.ast.expr.ClosureExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitLambdaExpression(org.codehaus.groovy.ast.expr.LambdaExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitTupleExpression(org.codehaus.groovy.ast.expr.TupleExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitArrayExpression(org.codehaus.groovy.ast.expr.ArrayExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitMapExpression(org.codehaus.groovy.ast.expr.MapExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitRangeExpression(org.codehaus.groovy.ast.expr.RangeExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitSpreadExpression(org.codehaus.groovy.ast.expr.SpreadExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitSpreadMapExpression(org.codehaus.groovy.ast.expr.SpreadMapExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitMethodPointerExpression(org.codehaus.groovy.ast.expr.MethodPointerExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitMethodReferenceExpression(org.codehaus.groovy.ast.expr.MethodReferenceExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitUnaryMinusExpression(org.codehaus.groovy.ast.expr.UnaryMinusExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitUnaryPlusExpression(org.codehaus.groovy.ast.expr.UnaryPlusExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitBitwiseNegationExpression(org.codehaus.groovy.ast.expr.BitwiseNegationExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitVariableExpression(org.codehaus.groovy.ast.expr.VariableExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitFieldExpression(org.codehaus.groovy.ast.expr.FieldExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitGStringExpression(org.codehaus.groovy.ast.expr.GStringExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitArgumentlistExpression(org.codehaus.groovy.ast.expr.ArgumentListExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitClosureListExpression(org.codehaus.groovy.ast.expr.ClosureListExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitBytecodeExpression(org.codehaus.groovy.classgen.BytecodeExpression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#wait(long, int), org.codehaus.groovy.ast.ClassCodeVisitorSupport#wait(), org.codehaus.groovy.ast.ClassCodeVisitorSupport#wait(long), org.codehaus.groovy.ast.ClassCodeVisitorSupport#equals(java.lang.Object), org.codehaus.groovy.ast.ClassCodeVisitorSupport#toString(), org.codehaus.groovy.ast.ClassCodeVisitorSupport#hashCode(), org.codehaus.groovy.ast.ClassCodeVisitorSupport#getClass(), org.codehaus.groovy.ast.ClassCodeVisitorSupport#notify(), org.codehaus.groovy.ast.ClassCodeVisitorSupport#notifyAll(), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visit(org.codehaus.groovy.ast.stmt.Statement), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visit(org.codehaus.groovy.ast.expr.Expression), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitListOfExpressions(java.util.List), org.codehaus.groovy.ast.ClassCodeVisitorSupport#visitEmptyExpression(org.codehaus.groovy.ast.expr.EmptyExpression) |
Add a new Violation to the list of violations found by this visitor. Only add the violation if the node lineNumber >= 0.
node - - the Groovy AST Nodemessage - - the message for the violation; defaults to nullGets the rule for this visitor.
Retrieve the List of Violations resulting from applying this visitor
Set the Rule associated with this visitor
rule - - the RuleSet the SourceCode associated with this visitor
sourceCode - - the SourceCode