org.checkerframework.common.util.report

Class ReportVisitor

java.lang.Object

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

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

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

org.checkerframework.common.basetype.BaseTypeVisitor<BaseAnnotatedTypeFactory>

org.checkerframework.common.util.report.ReportVisitor

All Implemented Interfaces:

com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

public class ReportVisitor
extends BaseTypeVisitor<BaseAnnotatedTypeFactory>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ReportVisitor.ReportTypeValidator

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

BaseTypeVisitor.OverrideChecker

Field Summary

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

atypeFactory, checker, contractsUtils, positions, typeValidator, visitorState

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

elements, root, trees, types

Constructor Summary

Constructors

Constructor and Description
ReportVisitor(BaseTypeChecker checker)

Method Summary

Modifier and Type	Method and Description
protected BaseAnnotatedTypeFactory	createTypeFactory() Constructs an instance of the appropriate type factory for the implemented type system.
protected BaseTypeValidator	createTypeValidator()
void	processClassTree(com.sun.source.tree.ClassTree node) Type-check classTree.
java.lang.Void	scan(com.sun.source.tree.Tree tree, java.lang.Void p)
java.lang.Void	visitArrayAccess(com.sun.source.tree.ArrayAccessTree node, java.lang.Void p)
java.lang.Void	visitAssignment(com.sun.source.tree.AssignmentTree node, java.lang.Void p) Performs two checks: subtyping and assignability checks, using BaseTypeVisitor.commonAssignmentCheck(Tree, ExpressionTree, String).
java.lang.Void	visitIdentifier(com.sun.source.tree.IdentifierTree node, java.lang.Void p)
java.lang.Void	visitInstanceOf(com.sun.source.tree.InstanceOfTree node, java.lang.Void p)
java.lang.Void	visitMemberSelect(com.sun.source.tree.MemberSelectTree node, java.lang.Void p)
java.lang.Void	visitMethod(com.sun.source.tree.MethodTree node, java.lang.Void p) Performs pseudo-assignment check: checks that the method obeys override and subtype rules to all overridden methods.
java.lang.Void	visitMethodInvocation(com.sun.source.tree.MethodInvocationTree node, java.lang.Void p) Performs a method invocation check.
java.lang.Void	visitModifiers(com.sun.source.tree.ModifiersTree node, java.lang.Void p)
java.lang.Void	visitNewArray(com.sun.source.tree.NewArrayTree node, java.lang.Void p)
java.lang.Void	visitNewClass(com.sun.source.tree.NewClassTree node, java.lang.Void p) Performs a new class invocation check.
java.lang.Void	visitTypeCast(com.sun.source.tree.TypeCastTree node, java.lang.Void p)

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

checkAccess, checkArguments, checkArrayInitialization, checkAssignability, checkConditionalPostcondition, checkConstructorInvocation, checkContract, checkDefaultConstructor, checkExceptionParameter, checkFieldInvariantDeclarations, checkForAnnotatedJdk, checkMethodInvocability, checkMethodReferenceAsOverride, checkOverride, checkOverride, checkPostcondition, checkPreconditions, checkThrownExpression, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, checkVarargs, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheck, createOverrideChecker, enclosingMemberSelect, enclosingStatement, getExceptionParameterLowerBoundAnnotations, getThrowUpperBoundAnnotations, getTypeFactory, isAccessAllowed, isAssignable, isValidUse, isValidUse, isValidUse, isVectorCopyInto, reportPurityErrors, setRoot, shouldSkipUses, skipReceiverSubtypeCheck, testTypevarContainment, typeCheckVectorCopyIntoArgument, validateType, validateTypeOf, visitAnnotation, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitEnhancedForLoop, visitLambdaExpression, visitMemberReference, visitParameterizedType, visitReturn, visitThrow, visitTry, visitTypeParameter, visitUnary, visitVariable

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, visitAnnotatedType, visitArrayType, visitAssert, visitBinary, visitBlock, visitBreak, visitCase, visitContinue, visitDoWhileLoop, visitEmptyStatement, visitErroneous, visitExpressionStatement, visitForLoop, visitIf, visitImport, visitIntersectionType, visitLabeledStatement, visitLiteral, visitOther, visitParenthesized, visitPrimitiveType, visitSwitch, visitSynchronized, visitUnionType, visitWhileLoop, visitWildcard

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportVisitor

public ReportVisitor(BaseTypeChecker checker)

Method Detail

createTypeFactory

protected BaseAnnotatedTypeFactory createTypeFactory()

Description copied from class: BaseTypeVisitor

Constructs an instance of the appropriate type factory for the implemented type system.

The default implementation uses the checker naming convention to create the appropriate type factory. If no factory is found, it returns BaseAnnotatedTypeFactory. It reflectively invokes the constructor that accepts this checker and compilation unit tree (in that order) as arguments.

Subclasses have to override this method to create the appropriate visitor if they do not follow the checker naming convention.

Overrides:

createTypeFactory in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

Returns:

the appropriate type factory

scan

public java.lang.Void scan(com.sun.source.tree.Tree tree,
                           java.lang.Void p)

Overrides:

scan in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

processClassTree

public void processClassTree(com.sun.source.tree.ClassTree node)

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:

node - class to check

visitMethod

public java.lang.Void visitMethod(com.sun.source.tree.MethodTree node,
                                  java.lang.Void p)

Description copied from class: BaseTypeVisitor

Performs pseudo-assignment check: checks that the method obeys override and subtype rules to all overridden methods.

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 com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitMethod in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitMethodInvocation

public java.lang.Void visitMethodInvocation(com.sun.source.tree.MethodInvocationTree node,
                                            java.lang.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 com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitMethodInvocation in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitMemberSelect

public java.lang.Void visitMemberSelect(com.sun.source.tree.MemberSelectTree node,
                                        java.lang.Void p)

Specified by:

visitMemberSelect in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitMemberSelect in class com.sun.source.util.TreeScanner<java.lang.Void,java.lang.Void>

visitIdentifier

public java.lang.Void visitIdentifier(com.sun.source.tree.IdentifierTree node,
                                      java.lang.Void p)

Specified by:

visitIdentifier in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitIdentifier in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitAssignment

public java.lang.Void visitAssignment(com.sun.source.tree.AssignmentTree node,
                                      java.lang.Void p)

Description copied from class: BaseTypeVisitor

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

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

Specified by:

visitAssignment in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitAssignment in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitArrayAccess

public java.lang.Void visitArrayAccess(com.sun.source.tree.ArrayAccessTree node,
                                       java.lang.Void p)

Specified by:

visitArrayAccess in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitArrayAccess in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitNewClass

public java.lang.Void visitNewClass(com.sun.source.tree.NewClassTree node,
                                    java.lang.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 com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitNewClass in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitNewArray

public java.lang.Void visitNewArray(com.sun.source.tree.NewArrayTree node,
                                    java.lang.Void p)

Specified by:

visitNewArray in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitNewArray in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitTypeCast

public java.lang.Void visitTypeCast(com.sun.source.tree.TypeCastTree node,
                                    java.lang.Void p)

Specified by:

visitTypeCast in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitTypeCast in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitInstanceOf

public java.lang.Void visitInstanceOf(com.sun.source.tree.InstanceOfTree node,
                                      java.lang.Void p)

Specified by:

visitInstanceOf in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitInstanceOf in class BaseTypeVisitor<BaseAnnotatedTypeFactory>

visitModifiers

public java.lang.Void visitModifiers(com.sun.source.tree.ModifiersTree node,
                                     java.lang.Void p)

Specified by:

visitModifiers in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitModifiers in class com.sun.source.util.TreeScanner<java.lang.Void,java.lang.Void>

createTypeValidator

protected BaseTypeValidator createTypeValidator()

Overrides:

createTypeValidator in class BaseTypeVisitor<BaseAnnotatedTypeFactory>