Package org.checkerframework.checker.modifiability

Class ModifiabilityVisitor

java.lang.Object

com.sun.source.util.TreeScanner<Void,Void>

com.sun.source.util.TreePathScanner<Void,Void>

org.checkerframework.framework.source.SourceVisitor<Void,Void>

org.checkerframework.checker.modifiability.ModifiabilityVisitor

All Implemented Interfaces:

TreeVisitor<Void,Void>

public class ModifiabilityVisitor
extends SourceVisitor<Void,Void>

Visitor for the aggregate ModifiabilityChecker.

The checks in this class are in the aggregate checker rather than in ModifiabilityBaseVisitor because they do not depend on a modifiability hierarchy; running them in each sub-checker would issue the same error five times.

Field Summary

Fields inherited from class org.checkerframework.framework.source.SourceVisitor

elements, root, trees, treesWithSuppressWarnings, types

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Void	visitAnnotation(AnnotationTree tree, Void p)
Void	visitLambdaExpression(LambdaExpressionTree tree, Void p)	Sets inParameterType while scanning this lambda's formal parameters, so that an explicitly-typed lambda parameter may be annotated @UnmodifiableParam, just as a method formal parameter may.
Void	visitMethod(MethodTree tree, Void p)	Sets inParameterType while scanning this method's formal and receiver parameters, so that visitAnnotation(com.sun.source.tree.AnnotationTree, java.lang.Void) can distinguish an allowed @UnmodifiableParam in a parameter type from a disallowed one elsewhere in the same method.

Methods inherited from class org.checkerframework.framework.source.SourceVisitor

scan, setRoot, storeSuppressWarningsAnno, visit, visitClass, visitVariable

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

getCurrentPath, scan

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

reduce, scan, visitAnnotatedType, 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, 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

Constructor Details

ModifiabilityVisitor

protected ModifiabilityVisitor(ModifiabilityChecker checker)

Creates a SourceVisitor to use for scanning a source tree.

Parameters:

checker - the modifiability checker to invoke on the input source tree

Method Details

visitMethod

public Void visitMethod(MethodTree tree,
 Void p)

Sets inParameterType while scanning this method's formal and receiver parameters, so that visitAnnotation(com.sun.source.tree.AnnotationTree, java.lang.Void) can distinguish an allowed @UnmodifiableParam in a parameter type from a disallowed one elsewhere in the same method.

The field needs no save-and-restore discipline, because neither a method declaration nor a lambda expression can appear within a formal parameter. It is reset in a finally clause because this visitor is reused for every compilation unit, and a stale true value would suppress every subsequent unmodparam.location error.

Specified by:

visitMethod in interface TreeVisitor<Void,Void>

Overrides:

visitMethod in class SourceVisitor<Void,Void>

visitLambdaExpression

public Void visitLambdaExpression(LambdaExpressionTree tree,
 Void p)

Sets inParameterType while scanning this lambda's formal parameters, so that an explicitly-typed lambda parameter may be annotated @UnmodifiableParam, just as a method formal parameter may. An implicitly-typed lambda parameter has no type to annotate.

Specified by:

visitLambdaExpression in interface TreeVisitor<Void,Void>

Overrides:

visitLambdaExpression in class TreeScanner<Void,Void>

visitAnnotation

public Void visitAnnotation(AnnotationTree tree,
 Void p)

Specified by:

visitAnnotation in interface TreeVisitor<Void,Void>

Overrides:

visitAnnotation in class TreeScanner<Void,Void>