Package org.checkerframework.framework.type

Class DefaultTypeHierarchy

java.lang.Object

org.checkerframework.framework.type.visitor.AbstractAtmComboVisitor<Boolean,Void>

org.checkerframework.framework.type.DefaultTypeHierarchy

All Implemented Interfaces:

TypeHierarchy, AtmComboVisitor<Boolean,Void>

public class DefaultTypeHierarchy
extends AbstractAtmComboVisitor<Boolean,Void>
implements TypeHierarchy

Default implementation of TypeHierarchy that implements the JLS specification with minor deviations as outlined by the Checker Framework manual. Changes to the JLS include forbidding covariant array types, raw types, and allowing covariant type arguments depending on various options passed to DefaultTypeHierarchy.

Subtyping rules of the JLS can be found in section 4.10, "Subtyping".

Note: The visit methods of this class must be public but it is intended to be used through a TypeHierarchy interface reference which will only allow isSubtype to be called. Clients should not call the visit methods.

The visit methods return true if the first argument is a subtype of the second argument.

Field Summary

Fields

Modifier and Type	Field	Description
protected final StructuralEqualityVisitHistory	areEqualVisitHistory	Stores the result of areEqualInHierarchy(AnnotatedTypeMirror, AnnotatedTypeMirror) for type arguments.
protected final BaseTypeChecker	checker	The type-checker that is associated with this.
protected AnnotationMirror	currentTop	The top annotation of the hierarchy currently being checked.
protected final StructuralEqualityComparer	equalityComparer	The equality comparer.
protected final boolean	ignoreRawTypes	Whether to ignore raw types.
protected final boolean	invariantArrayComponents	Whether to make array subtyping invariant with respect to array component types.
protected final SubtypeVisitHistory	isSubtypeVisitHistory	Stores the result of isSubtype, if that result is true.
protected final QualifierHierarchy	qualHierarchy	The qualifier hierarchy that is associated with this.

Constructor Summary

Constructors

Constructor	Description
DefaultTypeHierarchy(BaseTypeChecker checker, QualifierHierarchy qualHierarchy, boolean ignoreRawTypes, boolean invariantArrayComponents)	Creates a DefaultTypeHierarchy.

Method Summary

Modifier and Type	Method	Description
protected boolean	areAllSubtypes(Iterable<? extends AnnotatedTypeMirror> subtypes, AnnotatedTypeMirror supertype)	Are all the types in subtypes a subtype of supertype?
protected boolean	areEqualInHierarchy(AnnotatedTypeMirror type1, AnnotatedTypeMirror type2)
protected StructuralEqualityComparer	createEqualityComparer()	Create the equality comparer.
String	defaultErrorMessage(AnnotatedTypeMirror subtype, AnnotatedTypeMirror supertype, Void p)	Returns error message for the case when two types shouldn't be compared.
List<Integer>	getCovariantArgIndexes(AnnotatedTypeMirror.AnnotatedDeclaredType type)	Returns a list of the indices of the type arguments that are covariant.
protected boolean	isContainedBy(AnnotatedTypeMirror inside, AnnotatedTypeMirror outside, boolean canBeCovariant)	Returns true if outside contains inside, that is, if the set of types denoted by outside is a superset of, or equal to, the set of types denoted by inside.
protected boolean	isContainedMany(List<? extends AnnotatedTypeMirror> subtypeTypeArgs, List<? extends AnnotatedTypeMirror> supertypeTypeArgs, List<Integer> covariantArgIndexes)	Calls isContainedBy(AnnotatedTypeMirror, AnnotatedTypeMirror, boolean) on the two lists of type arguments.
protected boolean	isContainedWithinBounds(AnnotatedTypeMirror inside, AnnotatedTypeMirror outsideLower, AnnotatedTypeMirror outsideUpper, boolean canBeCovariant)	Let outside be ? super outsideLower extends outsideUpper.
protected boolean	isPrimarySubtype(AnnotatedTypeMirror subtype, AnnotatedTypeMirror supertype)	Compare the primary annotations of subtype and supertype.
boolean	isSubtype(AnnotatedTypeMirror subtype, AnnotatedTypeMirror supertype)	Returns true if subtype <: supertype.
protected boolean	isSubtype(AnnotatedTypeMirror subtype, AnnotatedTypeMirror supertype, AnnotationMirror top)	Returns true if subtype <: supertype, but only for the hierarchy of which top is the top.
protected boolean	isSubtypeCaching(AnnotatedTypeMirror subtype, AnnotatedTypeMirror supertype)	Like isSubtype(AnnotatedTypeMirror, AnnotatedTypeMirror), but uses a cache to prevent infinite recursion on recursive types.
boolean	isSubtypeShallowEffective(Collection<? extends AnnotationMirror> subQualifiers, AnnotatedTypeMirror supertype)	Tests whether subQualifiers are equal to or are sub-qualifiers of the effective annotations of supertype, according to the type qualifier hierarchy.
boolean	isSubtypeShallowEffective(AnnotationMirror subQualifier, AnnotatedTypeMirror supertype)	Tests whether subQualifier is equal to or sub-qualifier of the effective annotation of supertype in the same hierarchy as subQualifier according to the type qualifier hierarchy.
boolean	isSubtypeShallowEffective(AnnotatedTypeMirror subtype, Collection<? extends AnnotationMirror> superQualifiers)	Tests whether the effective annotations of subtype are equal to or are sub-qualifiers of superQualifiers, according to the type qualifier hierarchy.
boolean	isSubtypeShallowEffective(AnnotatedTypeMirror subtype, AnnotationMirror superQualifier)	Tests whether the effective annotation of subtype in the same hierarchy as superQualifier is equal to or sub-qualifier of superQualifier, according to the type qualifier hierarchy.
boolean	isSubtypeShallowEffective(AnnotatedTypeMirror subtype, AnnotatedTypeMirror supertype)	Tests whether the effective annotations of subtype are equal to or are sub-qualifiers of the effective annotations of supertype, according to the type qualifier hierarchy.
boolean	isSubtypeShallowEffective(AnnotatedTypeMirror subtype, AnnotatedTypeMirror supertype, AnnotationMirror hierarchy)	Tests whether the effective annotation in the same hierarchy as hierarchy of subtype are equal to or are sub-qualifiers of the effective annotation of supertype in the same hierarchy as hierarchy, according to the type qualifier hierarchy.
Boolean	visitArray_Array(AnnotatedTypeMirror.AnnotatedArrayType subtype, AnnotatedTypeMirror.AnnotatedArrayType supertype, Void p)
Boolean	visitArray_Declared(AnnotatedTypeMirror.AnnotatedArrayType subtype, AnnotatedTypeMirror.AnnotatedDeclaredType supertype, Void p)
Boolean	visitArray_Intersection(AnnotatedTypeMirror.AnnotatedArrayType subtype, AnnotatedTypeMirror.AnnotatedIntersectionType supertype, Void p)
Boolean	visitArray_Null(AnnotatedTypeMirror.AnnotatedArrayType subtype, AnnotatedTypeMirror.AnnotatedNullType supertype, Void p)
Boolean	visitArray_Typevar(AnnotatedTypeMirror.AnnotatedArrayType subtype, AnnotatedTypeMirror.AnnotatedTypeVariable superType, Void p)
Boolean	visitArray_Wildcard(AnnotatedTypeMirror.AnnotatedArrayType subtype, AnnotatedTypeMirror.AnnotatedWildcardType supertype, Void p)
Boolean	visitDeclared_Array(AnnotatedTypeMirror.AnnotatedDeclaredType subtype, AnnotatedTypeMirror.AnnotatedArrayType supertype, Void p)
Boolean	visitDeclared_Declared(AnnotatedTypeMirror.AnnotatedDeclaredType subtype, AnnotatedTypeMirror.AnnotatedDeclaredType supertype, Void p)
Boolean	visitDeclared_Intersection(AnnotatedTypeMirror.AnnotatedDeclaredType subtype, AnnotatedTypeMirror.AnnotatedIntersectionType supertype, Void p)
Boolean	visitDeclared_Null(AnnotatedTypeMirror.AnnotatedDeclaredType subtype, AnnotatedTypeMirror.AnnotatedNullType supertype, Void p)
Boolean	visitDeclared_Primitive(AnnotatedTypeMirror.AnnotatedDeclaredType subtype, AnnotatedTypeMirror.AnnotatedPrimitiveType supertype, Void p)
Boolean	visitDeclared_Typevar(AnnotatedTypeMirror.AnnotatedDeclaredType subtype, AnnotatedTypeMirror.AnnotatedTypeVariable supertype, Void p)
Boolean	visitDeclared_Union(AnnotatedTypeMirror.AnnotatedDeclaredType subtype, AnnotatedTypeMirror.AnnotatedUnionType supertype, Void p)
Boolean	visitDeclared_Wildcard(AnnotatedTypeMirror.AnnotatedDeclaredType subtype, AnnotatedTypeMirror.AnnotatedWildcardType supertype, Void p)
Boolean	visitIntersection_Declared(AnnotatedTypeMirror.AnnotatedIntersectionType subtype, AnnotatedTypeMirror.AnnotatedDeclaredType supertype, Void p)
Boolean	visitIntersection_Intersection(AnnotatedTypeMirror.AnnotatedIntersectionType subtype, AnnotatedTypeMirror.AnnotatedIntersectionType supertype, Void p)
Boolean	visitIntersection_Null(AnnotatedTypeMirror.AnnotatedIntersectionType subtype, AnnotatedTypeMirror.AnnotatedNullType supertype, Void p)
Boolean	visitIntersection_Primitive(AnnotatedTypeMirror.AnnotatedIntersectionType subtype, AnnotatedTypeMirror.AnnotatedPrimitiveType supertype, Void p)
protected boolean	visitIntersection_Type(AnnotatedTypeMirror.AnnotatedIntersectionType subtype, AnnotatedTypeMirror supertype)	An intersection is a subtype if one of its bounds is a subtype of supertype.
Boolean	visitIntersection_Typevar(AnnotatedTypeMirror.AnnotatedIntersectionType subtype, AnnotatedTypeMirror.AnnotatedTypeVariable supertype, Void p)
Boolean	visitIntersection_Wildcard(AnnotatedTypeMirror.AnnotatedIntersectionType subtype, AnnotatedTypeMirror.AnnotatedWildcardType supertype, Void p)
Boolean	visitNull_Array(AnnotatedTypeMirror.AnnotatedNullType subtype, AnnotatedTypeMirror.AnnotatedArrayType supertype, Void p)
Boolean	visitNull_Declared(AnnotatedTypeMirror.AnnotatedNullType subtype, AnnotatedTypeMirror.AnnotatedDeclaredType supertype, Void p)
Boolean	visitNull_Intersection(AnnotatedTypeMirror.AnnotatedNullType subtype, AnnotatedTypeMirror.AnnotatedIntersectionType supertype, Void p)
Boolean	visitNull_Null(AnnotatedTypeMirror.AnnotatedNullType subtype, AnnotatedTypeMirror.AnnotatedNullType supertype, Void p)
Boolean	visitNull_Primitive(AnnotatedTypeMirror.AnnotatedNullType subtype, AnnotatedTypeMirror.AnnotatedPrimitiveType supertype, Void p)
Boolean	visitNull_Typevar(AnnotatedTypeMirror.AnnotatedNullType subtype, AnnotatedTypeMirror.AnnotatedTypeVariable supertype, Void p)
Boolean	visitNull_Union(AnnotatedTypeMirror.AnnotatedNullType subtype, AnnotatedTypeMirror.AnnotatedUnionType supertype, Void p)
Boolean	visitNull_Wildcard(AnnotatedTypeMirror.AnnotatedNullType subtype, AnnotatedTypeMirror.AnnotatedWildcardType supertype, Void p)
Boolean	visitPrimitive_Declared(AnnotatedTypeMirror.AnnotatedPrimitiveType subtype, AnnotatedTypeMirror.AnnotatedDeclaredType supertype, Void p)
Boolean	visitPrimitive_Intersection(AnnotatedTypeMirror.AnnotatedPrimitiveType subtype, AnnotatedTypeMirror.AnnotatedIntersectionType supertype, Void p)
Boolean	visitPrimitive_Primitive(AnnotatedTypeMirror.AnnotatedPrimitiveType subtype, AnnotatedTypeMirror.AnnotatedPrimitiveType supertype, Void p)
Boolean	visitPrimitive_Typevar(AnnotatedTypeMirror.AnnotatedPrimitiveType subtype, AnnotatedTypeMirror.AnnotatedTypeVariable supertype, Void p)
Boolean	visitPrimitive_Wildcard(AnnotatedTypeMirror.AnnotatedPrimitiveType subtype, AnnotatedTypeMirror.AnnotatedWildcardType supertype, Void p)
protected boolean	visitType_Intersection(AnnotatedTypeMirror subtype, AnnotatedTypeMirror.AnnotatedIntersectionType supertype)	An intersection is a supertype if all of its bounds are a supertype of subtype.
protected boolean	visitType_Typevar(AnnotatedTypeMirror subtype, AnnotatedTypeMirror.AnnotatedTypeVariable supertype)	A type variable is a supertype if its lower bound is above subtype.
protected boolean	visitType_Wildcard(AnnotatedTypeMirror subtype, AnnotatedTypeMirror.AnnotatedWildcardType supertype)	Check a wildcard type's relation against a subtype.
protected boolean	visitTypeArgs(AnnotatedTypeMirror.AnnotatedDeclaredType subtype, AnnotatedTypeMirror.AnnotatedDeclaredType supertype, boolean subtypeRaw, boolean supertypeRaw)	Returns true if the type arguments in supertype contain the type arguments in subtype and false otherwise.
Boolean	visitTypevar_Array(AnnotatedTypeMirror.AnnotatedTypeVariable subtype, AnnotatedTypeMirror.AnnotatedArrayType supertype, Void p)
Boolean	visitTypevar_Declared(AnnotatedTypeMirror.AnnotatedTypeVariable subtype, AnnotatedTypeMirror.AnnotatedDeclaredType supertype, Void p)
Boolean	visitTypevar_Intersection(AnnotatedTypeMirror.AnnotatedTypeVariable subtype, AnnotatedTypeMirror.AnnotatedIntersectionType supertype, Void p)
Boolean	visitTypevar_Null(AnnotatedTypeMirror.AnnotatedTypeVariable subtype, AnnotatedTypeMirror.AnnotatedNullType supertype, Void p)
Boolean	visitTypevar_Primitive(AnnotatedTypeMirror.AnnotatedTypeVariable subtype, AnnotatedTypeMirror.AnnotatedPrimitiveType supertype, Void p)
protected boolean	visitTypevar_Type(AnnotatedTypeMirror.AnnotatedTypeVariable subtype, AnnotatedTypeMirror supertype)	A type variable is a subtype if its upper bound is below the supertype.
Boolean	visitTypevar_Typevar(AnnotatedTypeMirror.AnnotatedTypeVariable subtype, AnnotatedTypeMirror.AnnotatedTypeVariable supertype, Void p)
Boolean	visitTypevar_Wildcard(AnnotatedTypeMirror.AnnotatedTypeVariable subtype, AnnotatedTypeMirror.AnnotatedWildcardType supertype, Void p)
Boolean	visitUnion_Declared(AnnotatedTypeMirror.AnnotatedUnionType subtype, AnnotatedTypeMirror.AnnotatedDeclaredType supertype, Void p)
Boolean	visitUnion_Intersection(AnnotatedTypeMirror.AnnotatedUnionType subtype, AnnotatedTypeMirror.AnnotatedIntersectionType supertype, Void p)
protected boolean	visitUnion_Type(AnnotatedTypeMirror.AnnotatedUnionType subtype, AnnotatedTypeMirror supertype)	A union type is a subtype if ALL of its alternatives are subtypes of supertype.
Boolean	visitUnion_Typevar(AnnotatedTypeMirror.AnnotatedUnionType subtype, AnnotatedTypeMirror.AnnotatedTypeVariable supertype, Void p)
Boolean	visitUnion_Union(AnnotatedTypeMirror.AnnotatedUnionType subtype, AnnotatedTypeMirror.AnnotatedUnionType supertype, Void p)
Boolean	visitUnion_Wildcard(AnnotatedTypeMirror.AnnotatedUnionType subtype, AnnotatedTypeMirror.AnnotatedWildcardType supertype, Void p)
Boolean	visitWildcard_Array(AnnotatedTypeMirror.AnnotatedWildcardType subtype, AnnotatedTypeMirror.AnnotatedArrayType supertype, Void p)
Boolean	visitWildcard_Declared(AnnotatedTypeMirror.AnnotatedWildcardType subtype, AnnotatedTypeMirror.AnnotatedDeclaredType supertype, Void p)
Boolean	visitWildcard_Intersection(AnnotatedTypeMirror.AnnotatedWildcardType subtype, AnnotatedTypeMirror.AnnotatedIntersectionType supertype, Void p)
Boolean	visitWildcard_Primitive(AnnotatedTypeMirror.AnnotatedWildcardType subtype, AnnotatedTypeMirror.AnnotatedPrimitiveType supertype, Void p)
protected boolean	visitWildcard_Type(AnnotatedTypeMirror.AnnotatedWildcardType subtype, AnnotatedTypeMirror supertype)	Check a wildcard type's relation against a supertype.
Boolean	visitWildcard_Typevar(AnnotatedTypeMirror.AnnotatedWildcardType subtype, AnnotatedTypeMirror.AnnotatedTypeVariable supertype, Void p)
Boolean	visitWildcard_Wildcard(AnnotatedTypeMirror.AnnotatedWildcardType subtype, AnnotatedTypeMirror.AnnotatedWildcardType supertype, Void p)

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

visit, visitArray_Executable, visitArray_None, visitArray_Primitive, visitArray_Union, visitDeclared_Executable, visitDeclared_None, visitExecutable_Array, visitExecutable_Declared, visitExecutable_Executable, visitExecutable_Intersection, visitExecutable_None, visitExecutable_Null, visitExecutable_Primitive, visitExecutable_Typevar, visitExecutable_Union, visitExecutable_Wildcard, visitIntersection_Array, visitIntersection_Executable, visitIntersection_None, visitIntersection_Union, visitNone_Array, visitNone_Declared, visitNone_Executable, visitNone_Intersection, visitNone_None, visitNone_Null, visitNone_Primitive, visitNone_Union, visitNone_Wildcard, visitNull_Executable, visitNull_None, visitPrimitive_Array, visitPrimitive_Executable, visitPrimitive_None, visitPrimitive_Null, visitPrimitive_Union, visitTypevar_Executable, visitTypevar_None, visitTypevar_Union, visitUnion_Array, visitUnion_Executable, visitUnion_None, visitUnion_Null, visitUnion_Primitive, visitWildcard_Executable, visitWildcard_None, visitWildcard_Null, visitWildcard_Union

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.checkerframework.framework.type.visitor.AtmComboVisitor

defaultAction

Field Details

checker

protected final BaseTypeChecker checker

The type-checker that is associated with this.

Used for processingEnvironment when needed.

qualHierarchy

protected final QualifierHierarchy qualHierarchy

The qualifier hierarchy that is associated with this.

equalityComparer

protected final StructuralEqualityComparer equalityComparer

The equality comparer.

ignoreRawTypes

protected final boolean ignoreRawTypes

Whether to ignore raw types.

invariantArrayComponents

protected final boolean invariantArrayComponents

Whether to make array subtyping invariant with respect to array component types.

currentTop

protected AnnotationMirror currentTop

The top annotation of the hierarchy currently being checked.

isSubtypeVisitHistory

protected final SubtypeVisitHistory isSubtypeVisitHistory

Stores the result of isSubtype, if that result is true.

areEqualVisitHistory

protected final StructuralEqualityVisitHistory areEqualVisitHistory

Stores the result of areEqualInHierarchy(AnnotatedTypeMirror, AnnotatedTypeMirror) for type arguments. Prevents infinite recursion on types that refer to themselves. (Stores both true and false results.)

Constructor Details

DefaultTypeHierarchy

public DefaultTypeHierarchy(BaseTypeChecker checker,
 QualifierHierarchy qualHierarchy,
 boolean ignoreRawTypes,
 boolean invariantArrayComponents)

Creates a DefaultTypeHierarchy.

Parameters:

checker - the type-checker that is associated with this

qualHierarchy - the qualifier hierarchy that is associated with this

ignoreRawTypes - whether to ignore raw types

invariantArrayComponents - whether to make array subtyping invariant with respect to array component types

Method Details

createEqualityComparer

protected StructuralEqualityComparer createEqualityComparer()

Create the equality comparer.

Returns:

the equality comparer

isSubtype

public boolean isSubtype(AnnotatedTypeMirror subtype,
 AnnotatedTypeMirror supertype)

Returns true if subtype <: supertype.

This implementation iterates over all top annotations and invokes isSubtype(AnnotatedTypeMirror, AnnotatedTypeMirror, AnnotationMirror). Most type systems should not override this method, but instead override isSubtype(AnnotatedTypeMirror, AnnotatedTypeMirror, AnnotationMirror) or some of the visitXXX methods.

Specified by:

isSubtype in interface TypeHierarchy

Parameters:

subtype - expected subtype

supertype - expected supertype

Returns:

true if subtype is a subtype of supertype or equal to it

isSubtypeShallowEffective

public boolean isSubtypeShallowEffective(AnnotatedTypeMirror subtype,
 AnnotatedTypeMirror supertype)

Description copied from interface: TypeHierarchy

Tests whether the effective annotations of subtype are equal to or are sub-qualifiers of the effective annotations of supertype, according to the type qualifier hierarchy.

The underlying types of subtype and supertype are not necessarily in a Java subtyping relationship with one another and are only used by this method for special cases when qualifier subtyping depends on the Java basetype.

Specified by:

isSubtypeShallowEffective in interface TypeHierarchy

Parameters:

subtype - possible subtype

supertype - possible supertype

Returns:

true iff the effective annotations of subtype are equal to or are sub-qualifiers of the effective annotations of supertype

isSubtypeShallowEffective

public boolean isSubtypeShallowEffective(AnnotatedTypeMirror subtype,
 AnnotatedTypeMirror supertype,
 AnnotationMirror hierarchy)

Description copied from interface: TypeHierarchy

Tests whether the effective annotation in the same hierarchy as hierarchy of subtype are equal to or are sub-qualifiers of the effective annotation of supertype in the same hierarchy as hierarchy, according to the type qualifier hierarchy. Other annotations in subtype and supertype are ignored.

The underlying types of subtype and supertype are not necessarily in a Java subtyping relationship with one another and are only used by this method for special cases when qualifier subtyping depends on the Java basetype.

Specified by:

isSubtypeShallowEffective in interface TypeHierarchy

Parameters:

subtype - possible subtype

supertype - possible supertype

hierarchy - an annotation whose hierarchy is used to compare subtype and supertype

Returns:

true iff the effective annotation in the same hierarchy as hierarchy of subtype are equal to or are sub-qualifiers of the effective annotation of supertype in the same hierarchy as hierarchy

isSubtypeShallowEffective

public boolean isSubtypeShallowEffective(AnnotatedTypeMirror subtype,
 Collection<? extends AnnotationMirror> superQualifiers)

Description copied from interface: TypeHierarchy

Tests whether the effective annotations of subtype are equal to or are sub-qualifiers of superQualifiers, according to the type qualifier hierarchy. Other annotations in subtype are ignored.

The underlying type of subtype is only used by this method for special cases when qualifier subtyping depends on the Java basetype.

Specified by:

isSubtypeShallowEffective in interface TypeHierarchy

Parameters:

subtype - possible subtype

superQualifiers - possible superQualifiers

Returns:

true iff the effective annotations of subtype are equal to or are sub-qualifiers of superQualifiers

isSubtypeShallowEffective

public boolean isSubtypeShallowEffective(Collection<? extends AnnotationMirror> subQualifiers,
 AnnotatedTypeMirror supertype)

Description copied from interface: TypeHierarchy

Tests whether subQualifiers are equal to or are sub-qualifiers of the effective annotations of supertype, according to the type qualifier hierarchy. Other annotations in supertype are ignored.

The underlying type of supertype is used by this method for special cases when qualifier subtyping depends on the Java basetype.

Specified by:

isSubtypeShallowEffective in interface TypeHierarchy

Parameters:

subQualifiers - possible subQualifiers

supertype - possible supertype

Returns:

true iff subQualifiers are equal to or are sub-qualifiers of the effective annotations of supertype

isSubtypeShallowEffective

public boolean isSubtypeShallowEffective(AnnotatedTypeMirror subtype,
 AnnotationMirror superQualifier)

Description copied from interface: TypeHierarchy

Tests whether the effective annotation of subtype in the same hierarchy as superQualifier is equal to or sub-qualifier of superQualifier, according to the type qualifier hierarchy. The underlying types of subtype is only used by this method for special cases when qualifier subtyping depends on the Java basetype. Other annotations in subtype are ignored.

Specified by:

isSubtypeShallowEffective in interface TypeHierarchy

Parameters:

subtype - possible subtype

superQualifier - possible super qualifier

Returns:

true iffhe effective annotation of subtype in the same hierarchy as superQualifier is equal to or sub-qualifier of superQualifier

isSubtypeShallowEffective

public boolean isSubtypeShallowEffective(AnnotationMirror subQualifier,
 AnnotatedTypeMirror supertype)

Description copied from interface: TypeHierarchy

Tests whether subQualifier is equal to or sub-qualifier of the effective annotation of supertype in the same hierarchy as subQualifier according to the type qualifier hierarchy. The underlying types of supertype is only used by this method for special cases when qualifier subtyping depends on the Java basetype. Other annotations in supertype are ignored.

Specified by:

isSubtypeShallowEffective in interface TypeHierarchy

Parameters:

subQualifier - possible subQualifier

supertype - possible supertype

Returns:

true subQualifier is equal to or sub-qualifier of the effective annotation of supertype in the same hierarchy as subQualifier

isSubtype

protected boolean isSubtype(AnnotatedTypeMirror subtype,
 AnnotatedTypeMirror supertype,
 AnnotationMirror top)

Returns true if subtype <: supertype, but only for the hierarchy of which top is the top.

Parameters:

subtype - expected subtype

supertype - expected supertype

top - the top of the hierarchy for which we want to make a comparison

Returns:

true if subtype is a subtype of or equal to supertype, in the qualifier hierarchy whose top is top

defaultErrorMessage

public String defaultErrorMessage(AnnotatedTypeMirror subtype,
 AnnotatedTypeMirror supertype,
 Void p)

Returns error message for the case when two types shouldn't be compared.

Specified by:

defaultErrorMessage in interface AtmComboVisitor<Boolean,Void>

Parameters:

subtype - the first AnnotatedTypeMirror parameter to the visit method called

supertype - the second AnnotatedTypeMirror parameter to the visit method called

p - subtype specific parameter passed to every visit method

Returns:

error message for the case when two types shouldn't be compared

isPrimarySubtype

protected boolean isPrimarySubtype(AnnotatedTypeMirror subtype,
 AnnotatedTypeMirror supertype)

Compare the primary annotations of subtype and supertype. Neither type can be missing annotations.

Parameters:

subtype - a type that might be a subtype (with respect to primary annotations)

supertype - a type that might be a supertype (with respect to primary annotations)

Returns:

true if the primary annotation on subtype <: primary annotation on supertype for the current top.

isSubtypeCaching

protected boolean isSubtypeCaching(AnnotatedTypeMirror subtype,
 AnnotatedTypeMirror supertype)

Like isSubtype(AnnotatedTypeMirror, AnnotatedTypeMirror), but uses a cache to prevent infinite recursion on recursive types.

Parameters:

subtype - a type that may be a subtype

supertype - a type that may be a supertype

Returns:

true if subtype <: supertype

areAllSubtypes

protected boolean areAllSubtypes(Iterable<? extends AnnotatedTypeMirror> subtypes,
 AnnotatedTypeMirror supertype)

Are all the types in subtypes a subtype of supertype?

The underlying type mirrors of subtypes must be subtypes of the underlying type mirror of supertype.

areEqualInHierarchy

protected boolean areEqualInHierarchy(AnnotatedTypeMirror type1,
 AnnotatedTypeMirror type2)

isContainedBy

protected boolean isContainedBy(AnnotatedTypeMirror inside,
 AnnotatedTypeMirror outside,
 boolean canBeCovariant)

Returns true if outside contains inside, that is, if the set of types denoted by outside is a superset of, or equal to, the set of types denoted by inside.

Containment is described in JLS section 4.5.1 "Type Arguments of Parameterized Types".

As described in JLS section 4.10.2 Subtyping among Class and Interface Types, a declared type S is considered a supertype of another declared type T only if all of S's type arguments "contain" the corresponding type arguments of the subtype T.

Parameters:

inside - a possibly-contained type; its underlying type is contained by outside's underlying type

outside - a possibly-containing type; its underlying type contains inside's underlying type

canBeCovariant - whether or not type arguments are allowed to be covariant

Returns:

true if inside is contained by outside, or if canBeCovariant == true and inside <: outside

isContainedWithinBounds

protected boolean isContainedWithinBounds(AnnotatedTypeMirror inside,
 AnnotatedTypeMirror outsideLower,
 AnnotatedTypeMirror outsideUpper,
 boolean canBeCovariant)

Let outside be ? super outsideLower extends outsideUpper. Returns true if outside contains inside, that is, if the set of types denoted by outside is a superset of, or equal to, the set of types denoted by inside.

This method is a helper method for isContainedBy(AnnotatedTypeMirror, AnnotatedTypeMirror, boolean).

Parameters:

inside - a possibly-contained type

outsideLower - the lower bound of the possibly-containing type

outsideUpper - the upper bound of the possibly-containing type

canBeCovariant - whether or not type arguments are allowed to be covariant

Returns:

true if inside is contained by outside, or if canBeCovariant == true and inside <: outside

visitArray_Array

public Boolean visitArray_Array(AnnotatedTypeMirror.AnnotatedArrayType subtype,
 AnnotatedTypeMirror.AnnotatedArrayType supertype,
 Void p)

Specified by:

visitArray_Array in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitArray_Array in class AbstractAtmComboVisitor<Boolean,Void>

visitArray_Declared

public Boolean visitArray_Declared(AnnotatedTypeMirror.AnnotatedArrayType subtype,
 AnnotatedTypeMirror.AnnotatedDeclaredType supertype,
 Void p)

Specified by:

visitArray_Declared in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitArray_Declared in class AbstractAtmComboVisitor<Boolean,Void>

visitArray_Null

public Boolean visitArray_Null(AnnotatedTypeMirror.AnnotatedArrayType subtype,
 AnnotatedTypeMirror.AnnotatedNullType supertype,
 Void p)

Specified by:

visitArray_Null in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitArray_Null in class AbstractAtmComboVisitor<Boolean,Void>

visitArray_Intersection

public Boolean visitArray_Intersection(AnnotatedTypeMirror.AnnotatedArrayType subtype,
 AnnotatedTypeMirror.AnnotatedIntersectionType supertype,
 Void p)

Specified by:

visitArray_Intersection in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitArray_Intersection in class AbstractAtmComboVisitor<Boolean,Void>

visitArray_Wildcard

public Boolean visitArray_Wildcard(AnnotatedTypeMirror.AnnotatedArrayType subtype,
 AnnotatedTypeMirror.AnnotatedWildcardType supertype,
 Void p)

Specified by:

visitArray_Wildcard in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitArray_Wildcard in class AbstractAtmComboVisitor<Boolean,Void>

visitArray_Typevar

public Boolean visitArray_Typevar(AnnotatedTypeMirror.AnnotatedArrayType subtype,
 AnnotatedTypeMirror.AnnotatedTypeVariable superType,
 Void p)

Specified by:

visitArray_Typevar in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitArray_Typevar in class AbstractAtmComboVisitor<Boolean,Void>

visitDeclared_Array

public Boolean visitDeclared_Array(AnnotatedTypeMirror.AnnotatedDeclaredType subtype,
 AnnotatedTypeMirror.AnnotatedArrayType supertype,
 Void p)

Specified by:

visitDeclared_Array in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitDeclared_Array in class AbstractAtmComboVisitor<Boolean,Void>

visitDeclared_Declared

public Boolean visitDeclared_Declared(AnnotatedTypeMirror.AnnotatedDeclaredType subtype,
 AnnotatedTypeMirror.AnnotatedDeclaredType supertype,
 Void p)

Specified by:

visitDeclared_Declared in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitDeclared_Declared in class AbstractAtmComboVisitor<Boolean,Void>

visitTypeArgs

protected boolean visitTypeArgs(AnnotatedTypeMirror.AnnotatedDeclaredType subtype,
 AnnotatedTypeMirror.AnnotatedDeclaredType supertype,
 boolean subtypeRaw,
 boolean supertypeRaw)

Returns true if the type arguments in supertype contain the type arguments in subtype and false otherwise. See isContainedBy(org.checkerframework.framework.type.AnnotatedTypeMirror, org.checkerframework.framework.type.AnnotatedTypeMirror, boolean) for an explanation of containment.

Parameters:

subtype - a possible subtype

supertype - a possible supertype

subtypeRaw - whether subtype is a raw type

supertypeRaw - whether supertype is a raw type

Returns:

true if the type arguments in supertype contain the type arguments in subtype and false otherwise

getCovariantArgIndexes

public List<Integer> getCovariantArgIndexes(AnnotatedTypeMirror.AnnotatedDeclaredType type)

Description copied from interface: TypeHierarchy

Returns a list of the indices of the type arguments that are covariant.

Specified by:

getCovariantArgIndexes in interface TypeHierarchy

Parameters:

type - a type

Returns:

a list of the indices of the type arguments that are covariant

isContainedMany

protected boolean isContainedMany(List<? extends AnnotatedTypeMirror> subtypeTypeArgs,
 List<? extends AnnotatedTypeMirror> supertypeTypeArgs,
 List<Integer> covariantArgIndexes)

Calls isContainedBy(AnnotatedTypeMirror, AnnotatedTypeMirror, boolean) on the two lists of type arguments. Returns true if every type argument in supertypeTypeArgs contains the type argument at the same index in subtypeTypeArgs.

Parameters:

subtypeTypeArgs - subtype arguments

supertypeTypeArgs - supertype arguments

covariantArgIndexes - indexes into the type arguments list which correspond to the type arguments that are marked @Covariant.

Returns:

whether supertypeTypeArgs contain subtypeTypeArgs

visitDeclared_Intersection

public Boolean visitDeclared_Intersection(AnnotatedTypeMirror.AnnotatedDeclaredType subtype,
 AnnotatedTypeMirror.AnnotatedIntersectionType supertype,
 Void p)

Specified by:

visitDeclared_Intersection in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitDeclared_Intersection in class AbstractAtmComboVisitor<Boolean,Void>

visitDeclared_Null

public Boolean visitDeclared_Null(AnnotatedTypeMirror.AnnotatedDeclaredType subtype,
 AnnotatedTypeMirror.AnnotatedNullType supertype,
 Void p)

Specified by:

visitDeclared_Null in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitDeclared_Null in class AbstractAtmComboVisitor<Boolean,Void>

visitDeclared_Primitive

public Boolean visitDeclared_Primitive(AnnotatedTypeMirror.AnnotatedDeclaredType subtype,
 AnnotatedTypeMirror.AnnotatedPrimitiveType supertype,
 Void p)

Specified by:

visitDeclared_Primitive in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitDeclared_Primitive in class AbstractAtmComboVisitor<Boolean,Void>

visitDeclared_Typevar

public Boolean visitDeclared_Typevar(AnnotatedTypeMirror.AnnotatedDeclaredType subtype,
 AnnotatedTypeMirror.AnnotatedTypeVariable supertype,
 Void p)

Specified by:

visitDeclared_Typevar in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitDeclared_Typevar in class AbstractAtmComboVisitor<Boolean,Void>

visitDeclared_Union

public Boolean visitDeclared_Union(AnnotatedTypeMirror.AnnotatedDeclaredType subtype,
 AnnotatedTypeMirror.AnnotatedUnionType supertype,
 Void p)

Specified by:

visitDeclared_Union in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitDeclared_Union in class AbstractAtmComboVisitor<Boolean,Void>

visitDeclared_Wildcard

public Boolean visitDeclared_Wildcard(AnnotatedTypeMirror.AnnotatedDeclaredType subtype,
 AnnotatedTypeMirror.AnnotatedWildcardType supertype,
 Void p)

Specified by:

visitDeclared_Wildcard in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitDeclared_Wildcard in class AbstractAtmComboVisitor<Boolean,Void>

visitIntersection_Declared

public Boolean visitIntersection_Declared(AnnotatedTypeMirror.AnnotatedIntersectionType subtype,
 AnnotatedTypeMirror.AnnotatedDeclaredType supertype,
 Void p)

Specified by:

visitIntersection_Declared in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitIntersection_Declared in class AbstractAtmComboVisitor<Boolean,Void>

visitIntersection_Primitive

public Boolean visitIntersection_Primitive(AnnotatedTypeMirror.AnnotatedIntersectionType subtype,
 AnnotatedTypeMirror.AnnotatedPrimitiveType supertype,
 Void p)

Specified by:

visitIntersection_Primitive in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitIntersection_Primitive in class AbstractAtmComboVisitor<Boolean,Void>

visitIntersection_Intersection

public Boolean visitIntersection_Intersection(AnnotatedTypeMirror.AnnotatedIntersectionType subtype,
 AnnotatedTypeMirror.AnnotatedIntersectionType supertype,
 Void p)

Specified by:

visitIntersection_Intersection in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitIntersection_Intersection in class AbstractAtmComboVisitor<Boolean,Void>

visitIntersection_Null

public Boolean visitIntersection_Null(AnnotatedTypeMirror.AnnotatedIntersectionType subtype,
 AnnotatedTypeMirror.AnnotatedNullType supertype,
 Void p)

Specified by:

visitIntersection_Null in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitIntersection_Null in class AbstractAtmComboVisitor<Boolean,Void>

visitIntersection_Typevar

public Boolean visitIntersection_Typevar(AnnotatedTypeMirror.AnnotatedIntersectionType subtype,
 AnnotatedTypeMirror.AnnotatedTypeVariable supertype,
 Void p)

Specified by:

visitIntersection_Typevar in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitIntersection_Typevar in class AbstractAtmComboVisitor<Boolean,Void>

visitIntersection_Wildcard

public Boolean visitIntersection_Wildcard(AnnotatedTypeMirror.AnnotatedIntersectionType subtype,
 AnnotatedTypeMirror.AnnotatedWildcardType supertype,
 Void p)

Specified by:

visitIntersection_Wildcard in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitIntersection_Wildcard in class AbstractAtmComboVisitor<Boolean,Void>

visitNull_Array

public Boolean visitNull_Array(AnnotatedTypeMirror.AnnotatedNullType subtype,
 AnnotatedTypeMirror.AnnotatedArrayType supertype,
 Void p)

Specified by:

visitNull_Array in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitNull_Array in class AbstractAtmComboVisitor<Boolean,Void>

visitNull_Declared

public Boolean visitNull_Declared(AnnotatedTypeMirror.AnnotatedNullType subtype,
 AnnotatedTypeMirror.AnnotatedDeclaredType supertype,
 Void p)

Specified by:

visitNull_Declared in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitNull_Declared in class AbstractAtmComboVisitor<Boolean,Void>

visitNull_Typevar

public Boolean visitNull_Typevar(AnnotatedTypeMirror.AnnotatedNullType subtype,
 AnnotatedTypeMirror.AnnotatedTypeVariable supertype,
 Void p)

Specified by:

visitNull_Typevar in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitNull_Typevar in class AbstractAtmComboVisitor<Boolean,Void>

visitNull_Wildcard

public Boolean visitNull_Wildcard(AnnotatedTypeMirror.AnnotatedNullType subtype,
 AnnotatedTypeMirror.AnnotatedWildcardType supertype,
 Void p)

Specified by:

visitNull_Wildcard in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitNull_Wildcard in class AbstractAtmComboVisitor<Boolean,Void>

visitNull_Null

public Boolean visitNull_Null(AnnotatedTypeMirror.AnnotatedNullType subtype,
 AnnotatedTypeMirror.AnnotatedNullType supertype,
 Void p)

Specified by:

visitNull_Null in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitNull_Null in class AbstractAtmComboVisitor<Boolean,Void>

visitNull_Union

public Boolean visitNull_Union(AnnotatedTypeMirror.AnnotatedNullType subtype,
 AnnotatedTypeMirror.AnnotatedUnionType supertype,
 Void p)

Specified by:

visitNull_Union in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitNull_Union in class AbstractAtmComboVisitor<Boolean,Void>

visitNull_Intersection

public Boolean visitNull_Intersection(AnnotatedTypeMirror.AnnotatedNullType subtype,
 AnnotatedTypeMirror.AnnotatedIntersectionType supertype,
 Void p)

Specified by:

visitNull_Intersection in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitNull_Intersection in class AbstractAtmComboVisitor<Boolean,Void>

visitNull_Primitive

public Boolean visitNull_Primitive(AnnotatedTypeMirror.AnnotatedNullType subtype,
 AnnotatedTypeMirror.AnnotatedPrimitiveType supertype,
 Void p)

Specified by:

visitNull_Primitive in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitNull_Primitive in class AbstractAtmComboVisitor<Boolean,Void>

visitPrimitive_Declared

public Boolean visitPrimitive_Declared(AnnotatedTypeMirror.AnnotatedPrimitiveType subtype,
 AnnotatedTypeMirror.AnnotatedDeclaredType supertype,
 Void p)

Specified by:

visitPrimitive_Declared in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitPrimitive_Declared in class AbstractAtmComboVisitor<Boolean,Void>

visitPrimitive_Primitive

public Boolean visitPrimitive_Primitive(AnnotatedTypeMirror.AnnotatedPrimitiveType subtype,
 AnnotatedTypeMirror.AnnotatedPrimitiveType supertype,
 Void p)

Specified by:

visitPrimitive_Primitive in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitPrimitive_Primitive in class AbstractAtmComboVisitor<Boolean,Void>

visitPrimitive_Intersection

public Boolean visitPrimitive_Intersection(AnnotatedTypeMirror.AnnotatedPrimitiveType subtype,
 AnnotatedTypeMirror.AnnotatedIntersectionType supertype,
 Void p)

Specified by:

visitPrimitive_Intersection in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitPrimitive_Intersection in class AbstractAtmComboVisitor<Boolean,Void>

visitPrimitive_Typevar

public Boolean visitPrimitive_Typevar(AnnotatedTypeMirror.AnnotatedPrimitiveType subtype,
 AnnotatedTypeMirror.AnnotatedTypeVariable supertype,
 Void p)

Specified by:

visitPrimitive_Typevar in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitPrimitive_Typevar in class AbstractAtmComboVisitor<Boolean,Void>

visitPrimitive_Wildcard

public Boolean visitPrimitive_Wildcard(AnnotatedTypeMirror.AnnotatedPrimitiveType subtype,
 AnnotatedTypeMirror.AnnotatedWildcardType supertype,
 Void p)

Specified by:

visitPrimitive_Wildcard in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitPrimitive_Wildcard in class AbstractAtmComboVisitor<Boolean,Void>

visitUnion_Declared

public Boolean visitUnion_Declared(AnnotatedTypeMirror.AnnotatedUnionType subtype,
 AnnotatedTypeMirror.AnnotatedDeclaredType supertype,
 Void p)

Specified by:

visitUnion_Declared in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitUnion_Declared in class AbstractAtmComboVisitor<Boolean,Void>

visitUnion_Intersection

public Boolean visitUnion_Intersection(AnnotatedTypeMirror.AnnotatedUnionType subtype,
 AnnotatedTypeMirror.AnnotatedIntersectionType supertype,
 Void p)

Specified by:

visitUnion_Intersection in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitUnion_Intersection in class AbstractAtmComboVisitor<Boolean,Void>

visitUnion_Union

public Boolean visitUnion_Union(AnnotatedTypeMirror.AnnotatedUnionType subtype,
 AnnotatedTypeMirror.AnnotatedUnionType supertype,
 Void p)

Specified by:

visitUnion_Union in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitUnion_Union in class AbstractAtmComboVisitor<Boolean,Void>

visitUnion_Wildcard

public Boolean visitUnion_Wildcard(AnnotatedTypeMirror.AnnotatedUnionType subtype,
 AnnotatedTypeMirror.AnnotatedWildcardType supertype,
 Void p)

Specified by:

visitUnion_Wildcard in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitUnion_Wildcard in class AbstractAtmComboVisitor<Boolean,Void>

visitUnion_Typevar

public Boolean visitUnion_Typevar(AnnotatedTypeMirror.AnnotatedUnionType subtype,
 AnnotatedTypeMirror.AnnotatedTypeVariable supertype,
 Void p)

Specified by:

visitUnion_Typevar in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitUnion_Typevar in class AbstractAtmComboVisitor<Boolean,Void>

visitTypevar_Declared

public Boolean visitTypevar_Declared(AnnotatedTypeMirror.AnnotatedTypeVariable subtype,
 AnnotatedTypeMirror.AnnotatedDeclaredType supertype,
 Void p)

Specified by:

visitTypevar_Declared in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitTypevar_Declared in class AbstractAtmComboVisitor<Boolean,Void>

visitTypevar_Intersection

public Boolean visitTypevar_Intersection(AnnotatedTypeMirror.AnnotatedTypeVariable subtype,
 AnnotatedTypeMirror.AnnotatedIntersectionType supertype,
 Void p)

Specified by:

visitTypevar_Intersection in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitTypevar_Intersection in class AbstractAtmComboVisitor<Boolean,Void>

visitTypevar_Primitive

public Boolean visitTypevar_Primitive(AnnotatedTypeMirror.AnnotatedTypeVariable subtype,
 AnnotatedTypeMirror.AnnotatedPrimitiveType supertype,
 Void p)

Specified by:

visitTypevar_Primitive in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitTypevar_Primitive in class AbstractAtmComboVisitor<Boolean,Void>

visitTypevar_Array

public Boolean visitTypevar_Array(AnnotatedTypeMirror.AnnotatedTypeVariable subtype,
 AnnotatedTypeMirror.AnnotatedArrayType supertype,
 Void p)

Specified by:

visitTypevar_Array in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitTypevar_Array in class AbstractAtmComboVisitor<Boolean,Void>

visitTypevar_Typevar

public Boolean visitTypevar_Typevar(AnnotatedTypeMirror.AnnotatedTypeVariable subtype,
 AnnotatedTypeMirror.AnnotatedTypeVariable supertype,
 Void p)

Specified by:

visitTypevar_Typevar in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitTypevar_Typevar in class AbstractAtmComboVisitor<Boolean,Void>

visitTypevar_Null

public Boolean visitTypevar_Null(AnnotatedTypeMirror.AnnotatedTypeVariable subtype,
 AnnotatedTypeMirror.AnnotatedNullType supertype,
 Void p)

Specified by:

visitTypevar_Null in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitTypevar_Null in class AbstractAtmComboVisitor<Boolean,Void>

visitTypevar_Wildcard

public Boolean visitTypevar_Wildcard(AnnotatedTypeMirror.AnnotatedTypeVariable subtype,
 AnnotatedTypeMirror.AnnotatedWildcardType supertype,
 Void p)

Specified by:

visitTypevar_Wildcard in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitTypevar_Wildcard in class AbstractAtmComboVisitor<Boolean,Void>

visitWildcard_Array

public Boolean visitWildcard_Array(AnnotatedTypeMirror.AnnotatedWildcardType subtype,
 AnnotatedTypeMirror.AnnotatedArrayType supertype,
 Void p)

Specified by:

visitWildcard_Array in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitWildcard_Array in class AbstractAtmComboVisitor<Boolean,Void>

visitWildcard_Declared

public Boolean visitWildcard_Declared(AnnotatedTypeMirror.AnnotatedWildcardType subtype,
 AnnotatedTypeMirror.AnnotatedDeclaredType supertype,
 Void p)

Specified by:

visitWildcard_Declared in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitWildcard_Declared in class AbstractAtmComboVisitor<Boolean,Void>

visitWildcard_Intersection

public Boolean visitWildcard_Intersection(AnnotatedTypeMirror.AnnotatedWildcardType subtype,
 AnnotatedTypeMirror.AnnotatedIntersectionType supertype,
 Void p)

Specified by:

visitWildcard_Intersection in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitWildcard_Intersection in class AbstractAtmComboVisitor<Boolean,Void>

visitWildcard_Primitive

public Boolean visitWildcard_Primitive(AnnotatedTypeMirror.AnnotatedWildcardType subtype,
 AnnotatedTypeMirror.AnnotatedPrimitiveType supertype,
 Void p)

Specified by:

visitWildcard_Primitive in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitWildcard_Primitive in class AbstractAtmComboVisitor<Boolean,Void>

visitWildcard_Typevar

public Boolean visitWildcard_Typevar(AnnotatedTypeMirror.AnnotatedWildcardType subtype,
 AnnotatedTypeMirror.AnnotatedTypeVariable supertype,
 Void p)

Specified by:

visitWildcard_Typevar in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitWildcard_Typevar in class AbstractAtmComboVisitor<Boolean,Void>

visitWildcard_Wildcard

public Boolean visitWildcard_Wildcard(AnnotatedTypeMirror.AnnotatedWildcardType subtype,
 AnnotatedTypeMirror.AnnotatedWildcardType supertype,
 Void p)

Specified by:

visitWildcard_Wildcard in interface AtmComboVisitor<Boolean,Void>

Overrides:

visitWildcard_Wildcard in class AbstractAtmComboVisitor<Boolean,Void>

visitType_Intersection

protected boolean visitType_Intersection(AnnotatedTypeMirror subtype,
 AnnotatedTypeMirror.AnnotatedIntersectionType supertype)

An intersection is a supertype if all of its bounds are a supertype of subtype.

Parameters:

subtype - the possible subtype

supertype - the possible supertype

Returns:

true subtype is a subtype of supertype

visitIntersection_Type

protected boolean visitIntersection_Type(AnnotatedTypeMirror.AnnotatedIntersectionType subtype,
 AnnotatedTypeMirror supertype)

An intersection is a subtype if one of its bounds is a subtype of supertype.

Parameters:

subtype - an intersection type

supertype - an annotated type

Returns:

whether subtype is a subtype of supertype

visitType_Typevar

protected boolean visitType_Typevar(AnnotatedTypeMirror subtype,
 AnnotatedTypeMirror.AnnotatedTypeVariable supertype)

A type variable is a supertype if its lower bound is above subtype.

Parameters:

subtype - a type that might be a subtype

supertype - a type that might be a supertype

Returns:

true if subtype is a subtype of supertype

visitTypevar_Type

protected boolean visitTypevar_Type(AnnotatedTypeMirror.AnnotatedTypeVariable subtype,
 AnnotatedTypeMirror supertype)

A type variable is a subtype if its upper bound is below the supertype.

Parameters:

subtype - a type that might be a subtype

supertype - a type that might be a supertype

Returns:

true if subtype is a subtype of supertype

visitUnion_Type

protected boolean visitUnion_Type(AnnotatedTypeMirror.AnnotatedUnionType subtype,
 AnnotatedTypeMirror supertype)

A union type is a subtype if ALL of its alternatives are subtypes of supertype.

Parameters:

subtype - the potential subtype to check

supertype - the supertype to check

Returns:

whether all the alternatives of subtype are subtypes of supertype

visitType_Wildcard

protected boolean visitType_Wildcard(AnnotatedTypeMirror subtype,
 AnnotatedTypeMirror.AnnotatedWildcardType supertype)

Check a wildcard type's relation against a subtype.

Parameters:

subtype - the potential subtype to check

supertype - the wildcard supertype to check

Returns:

whether the subtype is a subtype of the supertype's super bound

visitWildcard_Type

protected boolean visitWildcard_Type(AnnotatedTypeMirror.AnnotatedWildcardType subtype,
 AnnotatedTypeMirror supertype)

Check a wildcard type's relation against a supertype.

Parameters:

subtype - the potential wildcard subtype to check

supertype - the supertype to check

Returns:

whether the subtype's extends bound is a subtype of the supertype