Package org.codehaus.groovy.classgen

Class ClassCompletionVerifier

java.lang.Object

org.codehaus.groovy.ast.CodeVisitorSupport

org.codehaus.groovy.ast.ClassCodeVisitorSupport

org.codehaus.groovy.classgen.ClassCompletionVerifier

All Implemented Interfaces:

GroovyClassVisitor, GroovyCodeVisitor, ErrorCollecting

public class ClassCompletionVerifier
extends ClassCodeVisitorSupport

Checks that a class satisfies various conditions including:

• Incorrect class or method access modifiers
• No abstract methods appear in a non-abstract class
• Existence and correct visibility for inherited members
• Invalid attempts to override final members

Constructor Summary

Constructors

Constructor	Description
ClassCompletionVerifier(SourceUnit source)	Creates a new class completion verifier.

Method Summary

Modifier and Type	Method	Description
ClassNode	getClassNode()	Returns the class node currently being verified.
protected SourceUnit	getSourceUnit()	Provides access to the SourceUnit for error reporting during visitation.
void	visitBinaryExpression(BinaryExpression expression)	Visits a BinaryExpression, traversing left and right operand expressions.
void	visitCatchStatement(CatchStatement cs)	Visits a CatchStatement, processing variable annotations and invoking the statement hook.
void	visitClass(ClassNode node)	Visits a ClassNode, processing its annotations, package, imports, contents, and object initializers.
void	visitConstantExpression(ConstantExpression expression)	Visits a ConstantExpression.
void	visitConstructor(ConstructorNode node)	Visits a ConstructorNode, processing its annotations, parameter annotations, and code block.
void	visitDeclarationExpression(DeclarationExpression expression)	Visits a DeclarationExpression with annotation processing, traversing expression annotations before delegating to parent traversal.
void	visitField(FieldNode node)	Visits a FieldNode, processing its annotations and initial value expression if present.
void	visitForLoop(ForStatement fs)	Visits a ForStatement, invoking statement hooks and processing loop variable annotations.
void	visitGStringExpression(GStringExpression expression)	Visits a GStringExpression, traversing string parts and interpolated value expressions.
void	visitMethod(MethodNode node)	Visits a MethodNode, processing its annotations, parameter annotations, and code block.
void	visitMethodCallExpression(MethodCallExpression mce)	Visits a MethodCallExpression, traversing the object expression, method expression, and argument list.
void	visitProperty(PropertyNode node)	Visits a PropertyNode, processing its annotations, initial value expression, and getter/setter blocks if present.

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

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

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

afterSwitchCaseStatementsVisited, afterSwitchConditionExpressionVisited, visitArgumentlistExpression, visitArrayExpression, visitAttributeExpression, visitBitwiseNegationExpression, visitBooleanExpression, visitBytecodeExpression, visitCastExpression, visitClassExpression, visitClosureListExpression, visitConstructorCallExpression, visitEmptyStatement, visitFieldExpression, visitLambdaExpression, visitListExpression, visitMapEntryExpression, visitMapExpression, 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

visit, visit, visitEmptyExpression, visitListOfExpressions

Constructor Details

ClassCompletionVerifier

public ClassCompletionVerifier(SourceUnit source)

Creates a new class completion verifier.

Parameters:

source - the source unit to verify

Method Details

getSourceUnit

protected SourceUnit getSourceUnit()

Provides access to the SourceUnit for error reporting during visitation. Implementations must override this method.

Specified by:

getSourceUnit in class ClassCodeVisitorSupport

Returns:

the source unit for this visitor

getClassNode

public ClassNode getClassNode()

Returns the class node currently being verified.

Returns:

the current class node

visitClass

public void visitClass(ClassNode node)

Visits a ClassNode, processing its annotations, package, imports, contents, and object initializers.

Specified by:

visitClass in interface GroovyClassVisitor

Overrides:

visitClass in class ClassCodeVisitorSupport

Parameters:

node - the class node to visit

visitMethod

public void visitMethod(MethodNode node)

Visits a MethodNode, processing its annotations, parameter annotations, and code block.

Specified by:

visitMethod in interface GroovyClassVisitor

Overrides:

visitMethod in class ClassCodeVisitorSupport

Parameters:

node - the method node to visit

visitField

public void visitField(FieldNode node)

Visits a FieldNode, processing its annotations and initial value expression if present.

Specified by:

visitField in interface GroovyClassVisitor

Overrides:

visitField in class ClassCodeVisitorSupport

Parameters:

node - the field node to visit

visitProperty

public void visitProperty(PropertyNode node)

Visits a PropertyNode, processing its annotations, initial value expression, and getter/setter blocks if present.

Specified by:

visitProperty in interface GroovyClassVisitor

Overrides:

visitProperty in class ClassCodeVisitorSupport

Parameters:

node - the property node to visit

visitBinaryExpression

public void visitBinaryExpression(BinaryExpression expression)

Visits a BinaryExpression, traversing left and right operand expressions.

Specified by:

visitBinaryExpression in interface GroovyCodeVisitor

Overrides:

visitBinaryExpression in class CodeVisitorSupport

Parameters:

expression - the binary expression

visitConstructor

public void visitConstructor(ConstructorNode node)

Visits a ConstructorNode, processing its annotations, parameter annotations, and code block.

Specified by:

visitConstructor in interface GroovyClassVisitor

Overrides:

visitConstructor in class ClassCodeVisitorSupport

Parameters:

node - the constructor node to visit

visitCatchStatement

public void visitCatchStatement(CatchStatement cs)

Visits a CatchStatement, processing variable annotations and invoking the statement hook.

Specified by:

visitCatchStatement in interface GroovyCodeVisitor

Overrides:

visitCatchStatement in class ClassCodeVisitorSupport

Parameters:

cs - the catch statement to visit

visitForLoop

public void visitForLoop(ForStatement fs)

Visits a ForStatement, invoking statement hooks and processing loop variable annotations.

Specified by:

visitForLoop in interface GroovyCodeVisitor

Overrides:

visitForLoop in class ClassCodeVisitorSupport

Parameters:

fs - the for statement to visit

visitMethodCallExpression

public void visitMethodCallExpression(MethodCallExpression mce)

Visits a MethodCallExpression, traversing the object expression, method expression, and argument list.

Specified by:

visitMethodCallExpression in interface GroovyCodeVisitor

Overrides:

visitMethodCallExpression in class CodeVisitorSupport

Parameters:

mce - the method call expression

visitDeclarationExpression

public void visitDeclarationExpression(DeclarationExpression expression)

Visits a DeclarationExpression with annotation processing, traversing expression annotations before delegating to parent traversal.

Specified by:

visitDeclarationExpression in interface GroovyCodeVisitor

Overrides:

visitDeclarationExpression in class ClassCodeVisitorSupport

Parameters:

expression - the declaration expression to visit

visitConstantExpression

public void visitConstantExpression(ConstantExpression expression)

Visits a ConstantExpression. No traversal is performed as constants contain no child expressions.

Specified by:

visitConstantExpression in interface GroovyCodeVisitor

Overrides:

visitConstantExpression in class CodeVisitorSupport

Parameters:

expression - the constant expression

visitGStringExpression

public void visitGStringExpression(GStringExpression expression)

Visits a GStringExpression, traversing string parts and interpolated value expressions.

Specified by:

visitGStringExpression in interface GroovyCodeVisitor

Overrides:

visitGStringExpression in class CodeVisitorSupport

Parameters:

expression - the GString expression