org.checkerframework.common.basetype

Class BaseTypeValidator

java.lang.Object

org.checkerframework.framework.type.visitor.AnnotatedTypeScanner<Void,Tree>

org.checkerframework.common.basetype.BaseTypeValidator

All Implemented Interfaces:

TypeValidator, AnnotatedTypeVisitor<Void,Tree>

Direct Known Subclasses:

ReportVisitor.ReportTypeValidator

public class BaseTypeValidator
extends AnnotatedTypeScanner<Void,Tree>
implements TypeValidator

A visitor to validate the types in a tree.

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotatedTypeFactory	atypeFactory
protected BaseTypeChecker	checker
protected boolean	isValid
protected BaseTypeVisitor<?>	visitor

Fields inherited from class org.checkerframework.framework.type.visitor.AnnotatedTypeScanner

visitedNodes

Constructor Summary

Constructors

Constructor and Description
BaseTypeValidator(BaseTypeChecker checker, BaseTypeVisitor<?> visitor, AnnotatedTypeFactory atypeFactory)

Method Summary

Modifier and Type	Method and Description
boolean	areBoundsValid(AnnotatedTypeMirror upperBound, AnnotatedTypeMirror lowerBound)
boolean	checkConflictingPrimaryAnnos(AnnotatedTypeMirror type, Tree tree) Determines if there are multiple qualifiers from a single hierarchy in type's primary annotations.
boolean	isValid(AnnotatedTypeMirror type, Tree tree) The entry point to the type validator.
protected void	reportError(AnnotatedTypeMirror type, Tree p)
protected void	reportInvalidBounds(AnnotatedTypeMirror type, Tree tree) Most errors reported by this class are of the form type.invalid.
protected void	reportValidityResult(@CompilerMessageKey String errorType, AnnotatedTypeMirror type, Tree p)
Void	visitArray(AnnotatedTypeMirror.AnnotatedArrayType type, Tree tree) Visits an array type.
Void	visitDeclared(AnnotatedTypeMirror.AnnotatedDeclaredType type, Tree tree) Visits a declared type.
Void	visitNull(AnnotatedTypeMirror.AnnotatedNullType type, Tree tree) Visits a null type.
protected Void	visitParameterizedType(AnnotatedTypeMirror.AnnotatedDeclaredType type, ParameterizedTypeTree tree) Checks that the annotations on the type arguments supplied to a type or a method invocation are within the bounds of the type variables as declared, and issues the "type.argument.type.incompatible" error if they are not.
Void	visitPrimitive(AnnotatedTypeMirror.AnnotatedPrimitiveType type, Tree tree) Visits a primitive type.
Void	visitTypeVariable(AnnotatedTypeMirror.AnnotatedTypeVariable type, Tree tree) Visits a type variable.
Void	visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType type, Tree tree) Visits a wildcard type.

Methods inherited from class org.checkerframework.framework.type.visitor.AnnotatedTypeScanner

reduce, reset, scan, scan, scanAndReduce, scanAndReduce, visit, visit, visitExecutable, visitIntersection, visitNoType, visitUnion

Methods inherited from class java.lang.Object

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

Field Detail

isValid

protected boolean isValid

checker

protected final BaseTypeChecker checker

visitor

protected final BaseTypeVisitor<?> visitor

atypeFactory

protected final AnnotatedTypeFactory atypeFactory

Constructor Detail

BaseTypeValidator

public BaseTypeValidator(BaseTypeChecker checker,
                         BaseTypeVisitor<?> visitor,
                         AnnotatedTypeFactory atypeFactory)

Method Detail

isValid

public boolean isValid(AnnotatedTypeMirror type,
                       Tree tree)

The entry point to the type validator. Validate the type against the given tree. Neither this method nor visit should be called directly by a visitor, only use BaseTypeVisitor.validateTypeOf(Tree).

Specified by:

isValid in interface TypeValidator

Parameters:

type - the type to validate

tree - the tree from which the type originated. Note that the tree might be a method tree -- the return type should then be validated. Note that the tree might be a variable tree -- the field type should then be validated.

Returns:

true, iff the type is valid

reportValidityResult

protected void reportValidityResult(@CompilerMessageKey String errorType,
                                    AnnotatedTypeMirror type,
                                    Tree p)

reportInvalidBounds

protected void reportInvalidBounds(AnnotatedTypeMirror type,
                                   Tree tree)

Most errors reported by this class are of the form type.invalid. This method reports when the bounds of a wildcard or type variable don't make sense. Bounds make sense when the effective annotations on the upper bound are supertypes of those on the lower bounds for all hierarchies. To ensure that this subtlety is not lost on users, we report "bound.type.incompatible" and print the bounds along with the invalid type rather than a "type.invalid".

reportError

protected void reportError(AnnotatedTypeMirror type,
                           Tree p)

visitDeclared

public Void visitDeclared(AnnotatedTypeMirror.AnnotatedDeclaredType type,
                          Tree tree)

Description copied from interface: AnnotatedTypeVisitor

Visits a declared type.

Specified by:

visitDeclared in interface AnnotatedTypeVisitor<Void,Tree>

Overrides:

visitDeclared in class AnnotatedTypeScanner<Void,Tree>

Parameters:

type - the type to visit

tree - a visitor-specified parameter

Returns:

a visitor-specified result

visitPrimitive

public Void visitPrimitive(AnnotatedTypeMirror.AnnotatedPrimitiveType type,
                           Tree tree)

Description copied from interface: AnnotatedTypeVisitor

Visits a primitive type.

Specified by:

visitPrimitive in interface AnnotatedTypeVisitor<Void,Tree>

Overrides:

visitPrimitive in class AnnotatedTypeScanner<Void,Tree>

Parameters:

type - the type to visit

tree - a visitor-specified parameter

Returns:

a visitor-specified result

visitArray

public Void visitArray(AnnotatedTypeMirror.AnnotatedArrayType type,
                       Tree tree)

Description copied from interface: AnnotatedTypeVisitor

Visits an array type.

Specified by:

visitArray in interface AnnotatedTypeVisitor<Void,Tree>

Overrides:

visitArray in class AnnotatedTypeScanner<Void,Tree>

Parameters:

type - the type to visit

tree - a visitor-specified parameter

Returns:

a visitor-specified result

visitParameterizedType

protected Void visitParameterizedType(AnnotatedTypeMirror.AnnotatedDeclaredType type,
                                      ParameterizedTypeTree tree)

Checks that the annotations on the type arguments supplied to a type or a method invocation are within the bounds of the type variables as declared, and issues the "type.argument.type.incompatible" error if they are not.

This method used to be visitParameterizedType, which incorrectly handles the main annotation on generic types.

visitTypeVariable

public Void visitTypeVariable(AnnotatedTypeMirror.AnnotatedTypeVariable type,
                              Tree tree)

Description copied from interface: AnnotatedTypeVisitor

Visits a type variable.

Specified by:

visitTypeVariable in interface AnnotatedTypeVisitor<Void,Tree>

Overrides:

visitTypeVariable in class AnnotatedTypeScanner<Void,Tree>

Parameters:

type - the type to visit

tree - a visitor-specified parameter

Returns:

a visitor-specified result

visitWildcard

public Void visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType type,
                          Tree tree)

Description copied from interface: AnnotatedTypeVisitor

Visits a wildcard type.

Specified by:

visitWildcard in interface AnnotatedTypeVisitor<Void,Tree>

Overrides:

visitWildcard in class AnnotatedTypeScanner<Void,Tree>

Parameters:

type - the type to visit

tree - a visitor-specified parameter

Returns:

a visitor-specified result

visitNull

public Void visitNull(AnnotatedTypeMirror.AnnotatedNullType type,
                      Tree tree)

Description copied from interface: AnnotatedTypeVisitor

Visits a null type.

Specified by:

visitNull in interface AnnotatedTypeVisitor<Void,Tree>

Overrides:

visitNull in class AnnotatedTypeScanner<Void,Tree>

Parameters:

type - the type to visit

tree - a visitor-specified parameter

Returns:

a visitor-specified result

areBoundsValid

public boolean areBoundsValid(AnnotatedTypeMirror upperBound,
                              AnnotatedTypeMirror lowerBound)

Returns:

true if the effective annotations on the upperBound are above those on the lowerBound

checkConflictingPrimaryAnnos

public boolean checkConflictingPrimaryAnnos(AnnotatedTypeMirror type,
                                            Tree tree)

Determines if there are multiple qualifiers from a single hierarchy in type's primary annotations. If so, report an error.

Parameters:

type - the type to check

tree - tree on which an error is reported

Returns:

true if an error was reported