Package org.checkerframework.framework.source

Class SourceVisitor<R,P>

java.lang.Object

com.sun.source.util.TreeScanner<R,P>

com.sun.source.util.TreePathScanner<R,P>

org.checkerframework.framework.source.SourceVisitor<R,P>

All Implemented Interfaces:

TreeVisitor<R,P>

Direct Known Subclasses:

BaseTypeVisitor, ModifiabilityVisitor

public abstract class SourceVisitor<R,P>
extends TreePathScanner<R,P>

An AST visitor that provides a variety of compiler utilities and interfaces to facilitate type-checking.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Elements	elements	The Elements helper to use when scanning.
protected CompilationUnitTree	root	The root of the AST that this SourceVisitor will scan.
protected final Trees	trees	The Trees instance to use for scanning.
final List<Tree>	treesWithSuppressWarnings	The trees that are annotated with @SuppressWarnings.
protected final Types	types	The Types helper to use when scanning.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SourceVisitor(SourceChecker checker)	Creates a SourceVisitor to use for scanning a source tree.

Method Summary

Modifier and Type	Method	Description
R	scan(Tree tree, P p)
void	setRoot(CompilationUnitTree newRoot)	Set the CompilationUnitTree to be used during any visits.
protected void	storeSuppressWarningsAnno(Tree tree)	If tree has a @SuppressWarnings add it to treesWithSuppressWarnings.
void	visit(TreePath path)	Entry point for a type processor: the TreePath leaf is a top-level type tree within root.
R	visitClass(ClassTree classTree, P p)
R	visitMethod(MethodTree tree, P p)
R	visitVariable(VariableTree variableTree, P p)

Methods inherited from class com.sun.source.util.TreePathScanner

getCurrentPath, scan

Methods inherited from class com.sun.source.util.TreeScanner

reduce, scan, visitAnnotatedType, visitAnnotation, visitAnyPattern, visitArrayAccess, visitArrayType, visitAssert, visitAssignment, visitBinary, visitBindingPattern, visitBlock, visitBreak, visitCase, visitCatch, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitConstantCaseLabel, visitContinue, visitDeconstructionPattern, visitDefaultCaseLabel, visitDoWhileLoop, visitEmptyStatement, visitEnhancedForLoop, visitErroneous, visitExports, visitExpressionStatement, visitForLoop, visitIdentifier, visitIf, visitImport, visitInstanceOf, visitIntersectionType, visitLabeledStatement, visitLambdaExpression, visitLiteral, visitMemberReference, visitMemberSelect, visitMethodInvocation, visitModifiers, visitModule, visitNewArray, visitNewClass, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPatternCaseLabel, visitPrimitiveType, visitProvides, visitRequires, visitReturn, visitStringTemplate, visitSwitch, visitSwitchExpression, visitSynchronized, visitThrow, visitTry, visitTypeCast, visitTypeParameter, visitUnary, visitUnionType, visitUses, visitWhileLoop, visitWildcard, visitYield

Methods inherited from class java.lang.Object

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

Field Details

trees

protected final Trees trees

The Trees instance to use for scanning.

elements

protected final Elements elements

The Elements helper to use when scanning.

types

protected final Types types

The Types helper to use when scanning.

root

protected CompilationUnitTree root

The root of the AST that this SourceVisitor will scan.

Is set by setRoot(com.sun.source.tree.CompilationUnitTree).

treesWithSuppressWarnings

public final List<Tree> treesWithSuppressWarnings

The trees that are annotated with @SuppressWarnings.

Constructor Details

SourceVisitor

protected SourceVisitor(SourceChecker checker)

Creates a SourceVisitor to use for scanning a source tree.

Parameters:

checker - the checker to invoke on the input source tree

Method Details

setRoot

public void setRoot(CompilationUnitTree newRoot)

Set the CompilationUnitTree to be used during any visits. For any later calls of com.sun.source.util.TreePathScanner.scan(TreePath, P), the CompilationUnitTree of the TreePath has to be equal to root.

Parameters:

newRoot - the new compilation unit

visit

public void visit(TreePath path)

Entry point for a type processor: the TreePath leaf is a top-level type tree within root.

scan

public R scan(Tree tree,
 P p)

Overrides:

scan in class TreePathScanner<R,P>

visitClass

public R visitClass(ClassTree classTree,
 P p)

Specified by:

visitClass in interface TreeVisitor<R,P>

Overrides:

visitClass in class TreeScanner<R,P>

visitVariable

public R visitVariable(VariableTree variableTree,
 P p)

Specified by:

visitVariable in interface TreeVisitor<R,P>

Overrides:

visitVariable in class TreeScanner<R,P>

visitMethod

public R visitMethod(MethodTree tree,
 P p)

Specified by:

visitMethod in interface TreeVisitor<R,P>

Overrides:

visitMethod in class TreeScanner<R,P>

storeSuppressWarningsAnno

protected void storeSuppressWarningsAnno(Tree tree)

If tree has a @SuppressWarnings add it to treesWithSuppressWarnings.

Parameters:

tree - a declaration on which a @SuppressWarnings annotation may be placed