Package 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	Description
protected final boolean	isMethodReference	True if overriderTree is a MEMBER_REFERENCE.
protected final AnnotatedTypeMirror.AnnotatedExecutableType	overridden	The type of the overridden method.
protected final AnnotatedTypeMirror	overriddenReturnType	The teturn type of the overridden method.
protected final AnnotatedTypeMirror.AnnotatedDeclaredType	overriddenType	The supertype that declares the overridden method.
protected final AnnotatedTypeMirror.AnnotatedExecutableType	overrider	The type of the overriding method.
protected final AnnotatedTypeMirror	overriderReturnType	The return type of the overriding method.
protected final Tree	overriderTree	The declaration of an overriding method.
protected final AnnotatedTypeMirror	overriderType	The subtype that declares the overriding method.

Constructor Summary

Constructors

Constructor	Description
OverrideChecker(Tree overriderTree, AnnotatedTypeMirror.AnnotatedExecutableType overrider, AnnotatedTypeMirror overriderType, AnnotatedTypeMirror overriderReturnType, AnnotatedTypeMirror.AnnotatedExecutableType overridden, AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType, AnnotatedTypeMirror overriddenReturnType)	Create an OverrideChecker.

Method Summary

Modifier and Type	Method	Description
boolean	checkOverride()	Perform the check.
protected boolean	checkReceiverOverride()	Issue an "override.receiver" 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 Details

overriderTree

protected final Tree overriderTree

The declaration of an overriding method. Or, it could be a method reference that is being passed to a method.

isMethodReference

protected final boolean isMethodReference

True if overriderTree is a MEMBER_REFERENCE.

overrider

protected final AnnotatedTypeMirror.AnnotatedExecutableType overrider

The type of the overriding method.

overriderType

protected final AnnotatedTypeMirror overriderType

The subtype that declares the overriding method.

overridden

protected final AnnotatedTypeMirror.AnnotatedExecutableType overridden

The type of the overridden method.

overriddenType

protected final AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType

The supertype that declares the overridden method.

overriddenReturnType

protected final AnnotatedTypeMirror overriddenReturnType

The teturn type of the overridden method.

overriderReturnType

protected final AnnotatedTypeMirror overriderReturnType

The return type of the overriding method.

Constructor Details

OverrideChecker

public OverrideChecker(Tree overriderTree,
 AnnotatedTypeMirror.AnnotatedExecutableType overrider,
 AnnotatedTypeMirror overriderType,
 AnnotatedTypeMirror overriderReturnType,
 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

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

overriderReturnType - 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 Details

checkOverride

public boolean checkOverride()

Perform the check.

Returns:

true if the override is allowed

checkReceiverOverride

protected boolean checkReceiverOverride()

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

Returns:

true if the override is legal