org.checkerframework.common.basetype

Class BaseTypeVisitor.OverrideChecker

java.lang.Object

org.checkerframework.common.basetype.BaseTypeVisitor.OverrideChecker

Direct Known Subclasses:

GuiEffectVisitor.GuiEffectOverrideChecker

Enclosing class:

BaseTypeVisitor<Factory extends GenericAnnotatedTypeFactory<?,?,?,?>>

public class BaseTypeVisitor.OverrideChecker
extends Object

Class to perform method override and method reference checks.

Method references are checked similarly to method overrides, with the method reference viewed as overriding the functional interface's method.

Checks that an overriding method's return type, parameter types, and receiver type are correct with respect to the annotations on the overridden method's return type, parameter types, and receiver type.

Furthermore, any contracts on the method must satisfy behavioral subtyping, that is, postconditions must be at least as strong as the postcondition on the superclass, and preconditions must be at most as strong as the condition on the superclass.

This method returns the result of the check, but also emits error messages as a side effect.

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	methodReference
protected AnnotatedTypeMirror.AnnotatedExecutableType	overridden
protected String	overriddenMeth
protected AnnotatedTypeMirror	overriddenReturnType
protected String	overriddenTyp
protected AnnotatedTypeMirror.AnnotatedDeclaredType	overriddenType
protected AnnotatedTypeMirror.AnnotatedExecutableType	overrider
protected String	overriderMeth
protected Tree	overriderTree
protected String	overriderTyp
protected AnnotatedTypeMirror	overridingReturnType
protected AnnotatedTypeMirror	overridingType

Constructor Summary

Constructors

Constructor and Description
OverrideChecker(Tree overriderTree, AnnotatedTypeMirror.AnnotatedExecutableType overrider, AnnotatedTypeMirror overridingType, AnnotatedTypeMirror overridingReturnType, AnnotatedTypeMirror.AnnotatedExecutableType overridden, AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType, AnnotatedTypeMirror overriddenReturnType) Create an OverrideChecker.

Method Summary

Modifier and Type	Method and Description
boolean	checkOverride() Perform the check.
protected boolean	checkReceiverOverride() Issue an "override.receiver.invalid" error if the receiver override is not valid.

Methods inherited from class java.lang.Object

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

Field Detail

overriderMeth

protected final String overriderMeth

overriderTyp

protected final String overriderTyp

overriddenMeth

protected final String overriddenMeth

overriddenTyp

protected final String overriddenTyp

overriderTree

protected final Tree overriderTree

methodReference

protected final Boolean methodReference

overrider

protected final AnnotatedTypeMirror.AnnotatedExecutableType overrider

overridingType

protected final AnnotatedTypeMirror overridingType

overridden

protected final AnnotatedTypeMirror.AnnotatedExecutableType overridden

overriddenType

protected final AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType

overriddenReturnType

protected final AnnotatedTypeMirror overriddenReturnType

overridingReturnType

protected final AnnotatedTypeMirror overridingReturnType

Constructor Detail

OverrideChecker

public OverrideChecker(Tree overriderTree,
                       AnnotatedTypeMirror.AnnotatedExecutableType overrider,
                       AnnotatedTypeMirror overridingType,
                       AnnotatedTypeMirror overridingReturnType,
                       AnnotatedTypeMirror.AnnotatedExecutableType overridden,
                       AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType,
                       AnnotatedTypeMirror overriddenReturnType)

Create an OverrideChecker.

Notice that the return types are passed in separately. This is to support some types of method references where the overrider's return type is not the appropriate type to check.

Parameters:

overriderTree - the AST node of the overriding method or method reference

overrider - the type of the overriding method

overridingType - the type enclosing the overrider method, usually an AnnotatedDeclaredType; for Method References may be something else

overridingReturnType - the return type of the overriding method

overridden - the type of the overridden method

overriddenType - the declared type enclosing the overridden method

overriddenReturnType - the return type of the overridden method

Method Detail

checkOverride

public boolean checkOverride()

Perform the check.

Returns:

true if the override is allowed

checkReceiverOverride

protected boolean checkReceiverOverride()

Issue an "override.receiver.invalid" error if the receiver override is not valid.

Returns:

true if the override is legal