Package org.checkerframework.common.util.report

Class ReportVisitor

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.common.basetype.BaseTypeVisitor<BaseAnnotatedTypeFactory>

org.checkerframework.common.util.report.ReportVisitor

All Implemented Interfaces:

TreeVisitor<Void,Void>

public class ReportVisitor
extends BaseTypeVisitor<BaseAnnotatedTypeFactory>

The visitor for the Report Checker.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ReportVisitor.ReportTypeValidator

Nested classes/interfaces inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

BaseTypeVisitor.FoundRequired, BaseTypeVisitor.OverrideChecker

Field Summary

Fields inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

assumePureGetters, atypeFactory, checker, DETERMINISTIC, ignoreTargetLocations, IMPURE, methodTree, positions, PURE, qualAllowedLocations, qualHierarchy, showchecks, SIDE_EFFECT_FREE, TARGET, targetValueElement, typeHierarchy, typeValidator, unusedWhenElement

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

elements, root, trees, treesWithSuppressWarnings, types

Constructor Summary

Constructors

Constructor	Description
ReportVisitor(BaseTypeChecker checker)

Method Summary

Modifier and Type	Method	Description
protected BaseTypeValidator	createTypeValidator()
void	processClassTree(ClassTree tree)	Type-check classTree.
Void	scan(Tree tree, Void p)
Void	visitArrayAccess(ArrayAccessTree tree, Void p)
Void	visitAssignment(AssignmentTree tree, Void p)	Performs two checks: subtyping and assignability checks, using BaseTypeVisitor.commonAssignmentCheck(Tree, ExpressionTree, String, Object[]).
Void	visitIdentifier(IdentifierTree tree, Void p)
Void	visitInstanceOf(InstanceOfTree tree, Void p)
Void	visitMemberSelect(MemberSelectTree tree, Void p)
Void	visitMethod(MethodTree tree, Void p)	Checks that the method obeys override and subtype rules to all overridden methods.
Void	visitMethodInvocation(MethodInvocationTree tree, Void p)	Performs a method invocation check.
Void	visitModifiers(ModifiersTree tree, Void p)
Void	visitNewArray(NewArrayTree tree, Void p)
Void	visitNewClass(NewClassTree tree, Void p)	Performs a new class invocation check.
Void	visitTypeCast(TypeCastTree tree, Void p)

Methods inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

checkAccess, checkAccessAllowed, checkArguments, checkArrayInitialization, checkConditionalPostcondition, checkConstructorInvocation, checkConstructorResult, checkContract, checkDefaultConstructor, checkEnclosingExpr, checkExceptionParameter, checkExplicitAnnotationsOnIntersectionBounds, checkExtendsAndImplements, checkExtendsOrImplements, checkFieldInvariantDeclarations, checkForPolymorphicQualifiers, checkForPolymorphicQualifiers, checkMethodInvocability, checkMethodReferenceAsOverride, checkOverride, checkOverride, checkPostcondition, checkPreconditions, checkPurity, checkQualifierParameter, checkSuperConstructorCall, checkThisConstructorCall, checkThisOrSuperConstructorCall, checkThrownExpression, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, checkVarargs, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckStartDiagnostic, contractExpressionAndType, createOverrideChecker, createQualAllowedLocations, createTypeFactory, createTypeFactoryPublic, enclosingMemberSelect, enclosingStatement, getExceptionParameterLowerBoundAnnotations, getThrowUpperBoundAnnotations, getTypeFactory, isTypeCastSafe, isValidUse, isValidUse, isValidUse, reportCommonAssignmentError, reportMethodInvocabilityError, reportPurityErrors, setRoot, shouldSkipUses, shouldWarnAboutIrrelevantJavaTypes, skipReceiverSubtypeCheck, testAnnotationInsertion, testJointJavacJavaParserVisitor, testTypevarContainment, typeCheckVectorCopyIntoArgument, validateTargetLocation, validateType, validateTypeOf, validateVariablesTargetLocation, visitAnnotatedType, visitAnnotatedType, visitAnnotation, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitEnhancedForLoop, visitLambdaExpression, visitMemberReference, visitReturn, visitSwitchExpression17, visitThrow, visitTypeParameter, visitUnary, visitVariable, warnAboutIrrelevantJavaTypes, warnRedundantAnnotations

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

visit

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

getCurrentPath, scan

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

reduce, scan, visitAnyPattern, visitArrayType, visitAssert, visitBinary, visitBindingPattern, visitBlock, visitBreak, visitCase, visitConstantCaseLabel, visitContinue, visitDeconstructionPattern, visitDefaultCaseLabel, visitDoWhileLoop, visitEmptyStatement, visitErroneous, visitExports, visitExpressionStatement, visitForLoop, visitIf, visitImport, visitIntersectionType, visitLabeledStatement, visitLiteral, visitModule, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPatternCaseLabel, visitPrimitiveType, visitProvides, visitRequires, visitStringTemplate, visitSwitch, visitSwitchExpression, visitSynchronized, visitTry, 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

ReportVisitor

public ReportVisitor(BaseTypeChecker checker)

Method Details

scan

public Void scan(Tree tree,
 Void p)

Overrides:

scan in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

processClassTree

public void processClassTree(ClassTree tree)

Description copied from class: BaseTypeVisitor

Type-check classTree. Subclasses should override this method instead of BaseTypeVisitor.visitClass(ClassTree, Void).

Overrides:

processClassTree in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

Parameters:

tree - class to check

visitMethod

public Void visitMethod(MethodTree tree,
 Void p)

Description copied from class: BaseTypeVisitor

Checks that the method obeys override and subtype rules to all overridden methods. (Uses the pseudo-assignment logic to do so.)

The override rule specifies that a method, m1, may override a method m2 only if:

• m1 return type is a subtype of m2
• m1 receiver type is a supertype of m2
• m1 parameters are supertypes of corresponding m2 parameters

Also, it issues a "missing.this" error for static method annotated receivers.

Specified by:

visitMethod in interface TreeVisitor<Void,Void>

Overrides:

visitMethod in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitMethodInvocation

public Void visitMethodInvocation(MethodInvocationTree tree,
 Void p)

Description copied from class: BaseTypeVisitor

Performs a method invocation check.

An invocation of a method, m, on the receiver, r is valid only if:

• passed arguments are subtypes of corresponding m parameters
• r is a subtype of m receiver type
• if m is generic, passed type arguments are subtypes of m type variables

Specified by:

visitMethodInvocation in interface TreeVisitor<Void,Void>

Overrides:

visitMethodInvocation in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitMemberSelect

public Void visitMemberSelect(MemberSelectTree tree,
 Void p)

Specified by:

visitMemberSelect in interface TreeVisitor<Void,Void>

Overrides:

visitMemberSelect in class TreeScanner<Void,Void>

visitIdentifier

public Void visitIdentifier(IdentifierTree tree,
 Void p)

Specified by:

visitIdentifier in interface TreeVisitor<Void,Void>

Overrides:

visitIdentifier in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitAssignment

public Void visitAssignment(AssignmentTree tree,
 Void p)

Description copied from class: BaseTypeVisitor

Performs two checks: subtyping and assignability checks, using BaseTypeVisitor.commonAssignmentCheck(Tree, ExpressionTree, String, Object[]).

If the subtype check fails, it issues an "assignment.type.incompatible" error.

Specified by:

visitAssignment in interface TreeVisitor<Void,Void>

Overrides:

visitAssignment in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitArrayAccess

public Void visitArrayAccess(ArrayAccessTree tree,
 Void p)

Specified by:

visitArrayAccess in interface TreeVisitor<Void,Void>

Overrides:

visitArrayAccess in class TreeScanner<Void,Void>

visitNewClass

public Void visitNewClass(NewClassTree tree,
 Void p)

Description copied from class: BaseTypeVisitor

Performs a new class invocation check.

An invocation of a constructor, c, is valid only if:

• passed arguments are subtypes of corresponding c parameters
• if c is generic, passed type arguments are subtypes of c type variables

Specified by:

visitNewClass in interface TreeVisitor<Void,Void>

Overrides:

visitNewClass in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitNewArray

public Void visitNewArray(NewArrayTree tree,
 Void p)

Specified by:

visitNewArray in interface TreeVisitor<Void,Void>

Overrides:

visitNewArray in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitTypeCast

public Void visitTypeCast(TypeCastTree tree,
 Void p)

Specified by:

visitTypeCast in interface TreeVisitor<Void,Void>

Overrides:

visitTypeCast in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitInstanceOf

public Void visitInstanceOf(InstanceOfTree tree,
 Void p)

Specified by:

visitInstanceOf in interface TreeVisitor<Void,Void>

Overrides:

visitInstanceOf in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitModifiers

public Void visitModifiers(ModifiersTree tree,
 Void p)

Specified by:

visitModifiers in interface TreeVisitor<Void,Void>

Overrides:

visitModifiers in class TreeScanner<Void,Void>

createTypeValidator

protected BaseTypeValidator createTypeValidator()

Overrides:

createTypeValidator in class BaseTypeVisitor<BaseAnnotatedTypeFactory>