Class CodeVisitor

java.lang.Object

io.github.mmm.code.api.object.CodeVisitor

Direct Known Subclasses:

CodeImportGeneratorVisitor

public abstract class CodeVisitor
extends Object

Generic visitor to traverse the code AST (abstract syntax tree). Allows to recursively visit CodeElements, CodeNodes, and other related code elements. To visit simply create your own sub-class and call according visit method (e.g. visitFile(CodeFile) on it. You implementation may be stateful and collect data in fields of your implementation. To avoid performance issues some recursive traversals are not enabled by default. You may therefore override methods like isVisitDocs(), isVisitProperties(), isVisitComments() to activate deeper and more greedy recursion. Also you may override other methods like isVisitFields(), etc. if recursion is not needed in your case.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
CodeVisitor()

Method Summary

Modifier and Type	Method	Description
protected void	doVisitBlock(CodeBlock block)
protected void	doVisitElement(CodeElement element)
protected void	doVisitExpression(CodeExpression expression)
protected void	doVisitOperation(CodeOperation operation)
protected void	doVisitTypePlaceholder(CodeTypePlaceholder type)
protected boolean	isVisitAnnotations()
protected boolean	isVisitBlocks()
protected boolean	isVisitBodies()
protected boolean	isVisitComments()
protected boolean	isVisitConstructors()
protected boolean	isVisitDocs()
protected boolean	isVisitExpressions()
protected boolean	isVisitFields()
protected boolean	isVisitImports()
protected boolean	isVisitMethods()
protected boolean	isVisitParameters()
protected boolean	isVisitProperties()
protected boolean	isVisitStatements()
protected boolean	isVisitSuperTypes()
protected boolean	isVisitVariables()
protected void	visitAnnotation(CodeAnnotation annotation)
protected void	visitArrayInstatiation(CodeArrayInstatiation expression)
protected void	visitArrayType(CodeArrayType type)
protected void	visitAssignment(CodeAssignment statement)
protected void	visitBlockFor(CodeBlockFor block)
protected void	visitBlockIf(CodeBlockIf block)
protected void	visitBlockStatement(CodeBlockStatement block)
protected void	visitBody(CodeBlockBody body)
protected void	visitCastExpression(CodeCastExpression expression)
protected void	visitComment(CodeComment comment)
protected void	visitComposedType(CodeComposedType type)
protected void	visitCondition(CodeCondition condition)
protected void	visitConstant(CodeConstant constant)
protected void	visitConstructor(CodeConstructor constructor)
protected void	visitDoc(CodeDoc doc)
protected void	visitExpression(CodeExpression expression)
protected void	visitExpressionCondition(CodeExpressionCondition expression)
protected void	visitField(CodeField field)
void	visitFile(CodeFile file)
protected void	visitForEachExpreesion(CodeForEachExpression expression)
protected void	visitForExpression(CodeForExpression expression)
protected void	visitForLoopExpression(CodeForLoopExpression expression)
protected void	visitGenericType(CodeGenericType type)
protected void	visitImport(CodeImport importStatement)
protected void	visitImportItem(CodeImportItem item)
protected void	visitLocalVariable(CodeLocalVariable variable)
protected void	visitMethod(CodeMethod method)
protected void	visitOperationInvocation(CodeOperationInvocation expression)
protected void	visitOperatorExpression(CodeOperatorExpression expression)
void	visitPackage(CodePackage pkg)
protected void	visitParameter(CodeParameter parameter)
protected void	visitParameterizedType(CodeParameterizedType type)
protected void	visitProperty(CodeProperty property)
protected void	visitReturns(CodeReturn returns)
protected void	visitReturnStatement(CodeReturnStatement statement)
protected void	visitStatement(CodeStatement statement)
protected void	visitSuperType(CodeGenericType superType)
protected void	visitTernaryExpression(CodeTernaryExpression expression)
void	visitTypeDeclaration(CodeType type)	This method is called to visit a type declaration and will recursively traverse the given CodeType extensively.
protected void	visitTypeReference(CodeType type)	This method will be called for every CodeType visited from code as reference.
protected void	visitTypeVariable(CodeTypeVariable type)
protected void	visitTypeWildcard(CodeTypeWildcard type)

Methods inherited from class Object

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

Constructor Details

CodeVisitor

public CodeVisitor()

Method Details

visitPackage

public void visitPackage(CodePackage pkg)

Parameters:

pkg - the CodePackage to visit.

visitFile

public void visitFile(CodeFile file)

Parameters:

file - the CodeFile to visit.

isVisitImports

protected boolean isVisitImports()

Returns:

true to visit import statements , false otherwise (ignore imports).

visitImport

protected void visitImport(CodeImport importStatement)

Parameters:

importStatement - the CodeImport to visit.

See Also:

• isVisitImports()

visitImportItem

protected void visitImportItem(CodeImportItem item)

Parameters:

item - the CodeImportItem to visit.

isVisitComments

protected boolean isVisitComments()

Returns:

true to visit comments, false otherwise (ignore comments).

visitComment

protected void visitComment(CodeComment comment)

Parameters:

comment - the CodeComment to visit.

See Also:

• isVisitComments()

isVisitDocs

protected boolean isVisitDocs()

Returns:

true to visit documentation, false otherwise (ignore doc).

visitDoc

protected void visitDoc(CodeDoc doc)

Parameters:

doc - the CodeDoc to visit.

See Also:

• isVisitDocs()

isVisitAnnotations

protected boolean isVisitAnnotations()

Returns:

true to visit annotations, false otherwise (ignore annotations).

visitAnnotation

protected void visitAnnotation(CodeAnnotation annotation)

Parameters:

annotation - the CodeAnnotation to visit.

See Also:

• isVisitAnnotations()

visitTypeDeclaration

public void visitTypeDeclaration(CodeType type)

This method is called to visit a type declaration and will recursively traverse the given CodeType extensively. However, further CodeType referenced from traversed children will be visited via visitTypeReference(CodeType) to avoid infinity loops as types can have cyclic references and visitors may also not expect such behavior.

Parameters:

type - the CodeType to visit.

See Also:

• visitTypeReference(CodeType)

visitTypeReference

protected void visitTypeReference(CodeType type)

This method will be called for every CodeType visited from code as reference. It will do nothing by default but can be overridden to collect referenced types.

Parameters:

type - the raw referenced CodeType to visit.

See Also:

• visitTypeDeclaration(CodeType)

isVisitSuperTypes

protected boolean isVisitSuperTypes()

Returns:

true to visit super-types, false otherwise (ignore super-types).

visitSuperType

protected void visitSuperType(CodeGenericType superType)

Parameters:

superType - the super-type to visit.

isVisitFields

protected boolean isVisitFields()

Returns:

true to visit fields, false otherwise (ignore fields).

visitField

protected void visitField(CodeField field)

Parameters:

field - the CodeField to visit.

isVisitConstructors

protected boolean isVisitConstructors()

Returns:

true to visit constructors, false otherwise (ignore constructors).

visitConstructor

protected void visitConstructor(CodeConstructor constructor)

Parameters:

constructor - the CodeConstructor to visit.

See Also:

• isVisitConstructors()

isVisitMethods

protected boolean isVisitMethods()

Returns:

true to visit methods, false otherwise (ignore methods).

visitMethod

protected void visitMethod(CodeMethod method)

Parameters:

method - the CodeMethod to visit.

See Also:

• isVisitMethods()

visitReturns

protected void visitReturns(CodeReturn returns)

Parameters:

returns - the CodeReturn to visit.

See Also:

• visitMethod(CodeMethod)

doVisitOperation

protected void doVisitOperation(CodeOperation operation)

Parameters:

operation - the CodeOperation to visit.

See Also:

• visitMethod(CodeMethod)
• visitConstructor(CodeConstructor)

isVisitProperties

protected boolean isVisitProperties()

Returns:

true to visit properties, false otherwise (ignore properties).

visitProperty

protected void visitProperty(CodeProperty property)

Parameters:

property - the CodeProperty to visit.

See Also:

• isVisitProperties()

isVisitParameters

protected boolean isVisitParameters()

Returns:

true to visit parameters, false otherwise (ignore parameters).

visitParameter

protected void visitParameter(CodeParameter parameter)

Parameters:

parameter - the CodeParameter to visit.

See Also:

• isVisitParameters()

isVisitBodies

protected boolean isVisitBodies()

Returns:

true to visit bodies (implementations), false otherwise (ignore bodies).

visitBody

protected void visitBody(CodeBlockBody body)

Parameters:

body - the CodeBlockBody to visit.

See Also:

• isVisitBodies()

isVisitBlocks

protected boolean isVisitBlocks()

Returns:

true to visit blocks (implementations), false otherwise (ignore blocks).

doVisitBlock

protected void doVisitBlock(CodeBlock block)

Parameters:

block - the CodeBlock to visit.

See Also:

• isVisitBlocks()

isVisitStatements

protected boolean isVisitStatements()

Returns:

true to visit statements, false otherwise (ignore statements).

visitStatement

protected void visitStatement(CodeStatement statement)

Parameters:

statement - the CodeStatement to visit.

visitBlockStatement

protected void visitBlockStatement(CodeBlockStatement block)

Parameters:

block - the CodeBlockStatement to visit.

visitBlockIf

protected void visitBlockIf(CodeBlockIf block)

Parameters:

block - the CodeBlockIf to visit.

See Also:

• visitBlockStatement(CodeBlockStatement)
• doVisitBlock(CodeBlock)

visitBlockFor

protected void visitBlockFor(CodeBlockFor block)

Parameters:

block - the CodeBlockFor to visit.

See Also:

• visitBlockStatement(CodeBlockStatement)
• doVisitBlock(CodeBlock)

visitReturnStatement

protected void visitReturnStatement(CodeReturnStatement statement)

Parameters:

statement - the CodeReturnStatement to visit.

visitAssignment

protected void visitAssignment(CodeAssignment statement)

Parameters:

statement - the CodeAssignment to visit.

See Also:

• visitStatement(CodeStatement)

isVisitVariables

protected boolean isVisitVariables()

Returns:

true to visit variables, false otherwise (ignore variables).

visitLocalVariable

protected void visitLocalVariable(CodeLocalVariable variable)

Parameters:

variable - the CodeLocalVariable to visit.

See Also:

• isVisitVariables()

isVisitExpressions

protected boolean isVisitExpressions()

Returns:

true to visit expressions, false otherwise (ignore expressions).

visitCondition

protected void visitCondition(CodeCondition condition)

Parameters:

condition - the CodeCondition to visit.

See Also:

• doVisitExpression(CodeExpression)

doVisitExpression

protected void doVisitExpression(CodeExpression expression)

Parameters:

expression - the CodeExpression to visit.

See Also:

• isVisitExpressions()
• visitExpression(CodeExpression)

visitExpression

protected void visitExpression(CodeExpression expression)

Parameters:

expression - the CodeExpression to visit.

See Also:

• isVisitExpressions()
• doVisitExpression(CodeExpression)

visitArrayInstatiation

protected void visitArrayInstatiation(CodeArrayInstatiation expression)

Parameters:

expression - the CodeArrayInstatiation to visit.

See Also:

• doVisitExpression(CodeExpression)

visitOperationInvocation

protected void visitOperationInvocation(CodeOperationInvocation expression)

Parameters:

expression - the CodeOperationInvocation to visit.

See Also:

• doVisitExpression(CodeExpression)

visitTernaryExpression

protected void visitTernaryExpression(CodeTernaryExpression expression)

Parameters:

expression - the CodeTernaryExpression to visit.

See Also:

• doVisitExpression(CodeExpression)

visitExpressionCondition

protected void visitExpressionCondition(CodeExpressionCondition expression)

Parameters:

expression - the CodeExpressionCondition to visit.

See Also:

• doVisitExpression(CodeExpression)

visitOperatorExpression

protected void visitOperatorExpression(CodeOperatorExpression expression)

Parameters:

expression - the CodeOperatorExpression to visit.

See Also:

• doVisitExpression(CodeExpression)

visitCastExpression

protected void visitCastExpression(CodeCastExpression expression)

Parameters:

expression - the CodeCastExpression to visit.

See Also:

• doVisitExpression(CodeExpression)

visitConstant

protected void visitConstant(CodeConstant constant)

Parameters:

constant - the CodeConstant to visit.

See Also:

• doVisitExpression(CodeExpression)

visitForExpression

protected void visitForExpression(CodeForExpression expression)

Parameters:

expression - the CodeForExpression to visit.

See Also:

• isVisitExpressions()

visitForEachExpreesion

protected void visitForEachExpreesion(CodeForEachExpression expression)

Parameters:

expression - the CodeForEachExpression to visit.

See Also:

• visitForExpression(CodeForExpression)

visitForLoopExpression

protected void visitForLoopExpression(CodeForLoopExpression expression)

Parameters:

expression - the CodeForLoopExpression to visit.

See Also:

• visitForExpression(CodeForExpression)

doVisitElement

protected void doVisitElement(CodeElement element)

Parameters:

element - the CodeElement to visit.

visitGenericType

protected void visitGenericType(CodeGenericType type)

Parameters:

type - the CodeGenericType to visit.

visitComposedType

protected void visitComposedType(CodeComposedType type)

Parameters:

type - the CodeComposedType to visit.

visitParameterizedType

protected void visitParameterizedType(CodeParameterizedType type)

Parameters:

type - the CodeParameterizedType to visit.

visitArrayType

protected void visitArrayType(CodeArrayType type)

Parameters:

type - the CodeArrayType to visit.

doVisitTypePlaceholder

protected void doVisitTypePlaceholder(CodeTypePlaceholder type)

Parameters:

type - the CodeTypePlaceholder to visit.

visitTypeVariable

protected void visitTypeVariable(CodeTypeVariable type)

Parameters:

type - the CodeTypeVariable to visit.

visitTypeWildcard

protected void visitTypeWildcard(CodeTypeWildcard type)

Parameters:

type - the CodeTypeWildcard to visit.