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>

Direct Known Subclasses:

KeyForAnnotatedTypeFactory.KeyForTypeHierarchy

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": https://docs.oracle.com/javase/specs/jls/se10/html/jls-4.html#jls-4.10

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. It does not make sense to call the visit methods on their own.

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseTypeChecker	checker
protected AnnotationMirror	currentTop
protected StructuralEqualityComparer	equalityComparer
protected boolean	ignoreRawTypes
protected boolean	invariantArrayComponents
protected QualifierHierarchy	qualifierHierarchy
protected SubtypeVisitHistory	typeargVisitHistory
protected SubtypeVisitHistory	visitHistory

Constructor Summary

Constructors

Constructor and Description
DefaultTypeHierarchy(BaseTypeChecker checker, QualifierHierarchy qualifierHierarchy, boolean ignoreRawTypes, boolean invariantArrayComponents)

Method Summary

Modifier and Type	Method and Description
protected boolean	areAllSubtypes(Iterable<? extends AnnotatedTypeMirror> subtypes, AnnotatedTypeMirror supertype)
protected boolean	areEqualInHierarchy(AnnotatedTypeMirror type1, AnnotatedTypeMirror type2)
static <T extends AnnotatedTypeMirror> T	castedAsSuper(AnnotatedTypeMirror subtype, T supertype) Calls asSuper and casts the result to the same type as the input supertype.
protected boolean	checkAndSubtype(AnnotatedTypeMirror subtype, AnnotatedTypeMirror supertype) Check and subtype first determines if the subtype/supertype combination has already been visited.
StructuralEqualityComparer	createEqualityComparer()
protected String	defaultErrorMessage(AnnotatedTypeMirror subtype, AnnotatedTypeMirror supertype, Void p) Formats type1, type2 and param into an error message used by all methods of AbstractAtmComboVisitor that are not overridden.
protected boolean	isAnnoSubtype(AnnotationMirror subtypeAnno, AnnotationMirror supertypeAnno, boolean annosCanBeEmtpy) Compare the primary annotations of subtype and supertype.
protected boolean	isBottom(AnnotatedTypeMirror subtype) Checks to see if subtype is bottom (if a bottom exists) If there is no explicit bottom then false is returned.
protected boolean	isContainedBy(AnnotatedTypeMirror inside, AnnotatedTypeMirror outside, boolean canBeCovariant) A declared type is considered a supertype of another declared type only if all of the type arguments of the declared type "contain" the corresponding type arguments of the subtype.
protected boolean	isPrimarySubtype(AnnotatedTypeMirror subtype, AnnotatedTypeMirror supertype) Compare the primary annotations of subtype and supertype.
protected boolean	isPrimarySubtype(AnnotatedTypeMirror subtype, AnnotatedTypeMirror supertype, boolean annosCanBeEmtpy) 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	isSubtypeOfAll(AnnotatedTypeMirror subtype, Iterable<? extends AnnotatedTypeMirror> supertypes)
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_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)
Boolean	visitIntersection_Typevar(AnnotatedTypeMirror.AnnotatedIntersectionType subtype, AnnotatedTypeMirror.AnnotatedTypeVariable supertype, Void p)
protected boolean	visitIntersectionSupertype(AnnotatedTypeMirror subtype, AnnotatedTypeMirror.AnnotatedIntersectionType supertype) An intersection is a supertype if all of its bounds are a supertype of subtype.
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)
Boolean	visitTypeArgs(AnnotatedTypeMirror.AnnotatedDeclaredType subtype, AnnotatedTypeMirror.AnnotatedDeclaredType supertype, boolean subtypeRaw, boolean supertypeRaw) A helper class for visitDeclared_Declared.
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)
Boolean	visitTypevar_Typevar(AnnotatedTypeMirror.AnnotatedTypeVariable subtype, AnnotatedTypeMirror.AnnotatedTypeVariable supertype, Void p)
Boolean	visitTypevar_Wildcard(AnnotatedTypeMirror.AnnotatedTypeVariable subtype, AnnotatedTypeMirror.AnnotatedWildcardType supertype, Void p)
protected boolean	visitTypevarSubtype(AnnotatedTypeMirror.AnnotatedTypeVariable subtype, AnnotatedTypeMirror supertype) A type variable is a subtype if its upper bounds is below the supertype.
protected boolean	visitTypevarSupertype(AnnotatedTypeMirror subtype, AnnotatedTypeMirror.AnnotatedTypeVariable supertype) A type variable is a supertype if its lower bound is above subtype.
Boolean	visitUnion_Declared(AnnotatedTypeMirror.AnnotatedUnionType subtype, AnnotatedTypeMirror.AnnotatedDeclaredType supertype, Void p)
Boolean	visitUnion_Intersection(AnnotatedTypeMirror.AnnotatedUnionType subtype, AnnotatedTypeMirror.AnnotatedIntersectionType 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)
protected Boolean	visitUnionSubtype(AnnotatedTypeMirror.AnnotatedUnionType subtype, AnnotatedTypeMirror supertype) A union type is a subtype if ALL of its alternatives are subtypes of supertype.
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)
Boolean	visitWildcard_Typevar(AnnotatedTypeMirror.AnnotatedWildcardType subtype, AnnotatedTypeMirror.AnnotatedTypeVariable supertype, Void p)
Boolean	visitWildcard_Wildcard(AnnotatedTypeMirror.AnnotatedWildcardType subtype, AnnotatedTypeMirror.AnnotatedWildcardType supertype, Void p)
protected boolean	visitWildcardSubtype(AnnotatedTypeMirror.AnnotatedWildcardType subtype, AnnotatedTypeMirror supertype)
protected boolean	visitWildcardSupertype(AnnotatedTypeMirror subtype, AnnotatedTypeMirror.AnnotatedWildcardType supertype)

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

defaultAction, visit, visitArray_Executable, visitArray_None, visitArray_Primitive, visitArray_Typevar, 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, visitIntersection_Wildcard, 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_Array, visitTypevar_Executable, visitTypevar_None, visitTypevar_Union, visitUnion_Array, visitUnion_Executable, visitUnion_None, visitUnion_Null, visitUnion_Primitive, visitUnion_Typevar, 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

Field Detail

checker

protected final BaseTypeChecker checker

qualifierHierarchy

protected final QualifierHierarchy qualifierHierarchy

equalityComparer

protected final StructuralEqualityComparer equalityComparer

ignoreRawTypes

protected final boolean ignoreRawTypes

invariantArrayComponents

protected final boolean invariantArrayComponents

currentTop

protected AnnotationMirror currentTop

visitHistory

protected final SubtypeVisitHistory visitHistory

typeargVisitHistory

protected final SubtypeVisitHistory typeargVisitHistory

Constructor Detail

DefaultTypeHierarchy

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

Method Detail

createEqualityComparer

public StructuralEqualityComparer createEqualityComparer()

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 actually a subtype of supertype

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 hierarchy for which we want to make a comparison

Returns:

returns true if subtype is a subtype of supertype in the qualifier hierarchy whose top is top

defaultErrorMessage

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

Description copied from class: AbstractAtmComboVisitor

Formats type1, type2 and param into an error message used by all methods of AbstractAtmComboVisitor that are not overridden. Normally, this method should indicate that the given method (and therefore the given pair of type mirror classes) is not supported by this class.

Specified by:

defaultErrorMessage in class AbstractAtmComboVisitor<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.

Returns:

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

isPrimarySubtype

protected boolean isPrimarySubtype(AnnotatedTypeMirror subtype,
                                   AnnotatedTypeMirror supertype,
                                   boolean annosCanBeEmtpy)

Compare the primary annotations of subtype and supertype.

Parameters:

annosCanBeEmtpy - indicates that annotations may be missing from the typemirror

Returns:

true if the primary annotation on subtype <: primary annotation on supertype for the current top or both annotations are null. False is returned if one annotation is null and the other is not.

isAnnoSubtype

protected boolean isAnnoSubtype(AnnotationMirror subtypeAnno,
                                AnnotationMirror supertypeAnno,
                                boolean annosCanBeEmtpy)

Compare the primary annotations of subtype and supertype.

Parameters:

subtypeAnno - annotation we expect to be a subtype

supertypeAnno - annotation we expect to be a supertype of subtype

annosCanBeEmtpy - indicates that annotations may be missing from the typemirror

Returns:

true if subtype <: supertype or both annotations are null. False is returned if one annotation is null and the other is not.

isBottom

protected boolean isBottom(AnnotatedTypeMirror subtype)

Checks to see if subtype is bottom (if a bottom exists) If there is no explicit bottom then false is returned.

Parameters:

subtype - type to isValid against bottom

Returns:

true if subtype's primary annotation is bottom

checkAndSubtype

protected boolean checkAndSubtype(AnnotatedTypeMirror subtype,
                                  AnnotatedTypeMirror supertype)

Check and subtype first determines if the subtype/supertype combination has already been visited. If so, it returns true, otherwise add the subtype/supertype combination and then make a subtype check

isSubtypeOfAll

protected boolean isSubtypeOfAll(AnnotatedTypeMirror subtype,
                                 Iterable<? extends AnnotatedTypeMirror> supertypes)

areAllSubtypes

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

areEqualInHierarchy

protected boolean areEqualInHierarchy(AnnotatedTypeMirror type1,
                                      AnnotatedTypeMirror type2)

isContainedBy

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

A declared type is considered a supertype of another declared type only if all of the type arguments of the declared type "contain" the corresponding type arguments of the subtype. Containment is described in the JLS section 4.5.1 "Type Arguments of Parameterized Types", https://docs.oracle.com/javase/specs/jls/se10/html/jls-4.html#jls-4.5.1

Parameters:

inside - the "subtype" type argument

outside - the "supertype" type argument

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

Returns:

true if inside is contained by outside OR, if canBeCovariant == true, inside is a subtype of 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>

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

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

A helper class for visitDeclared_Declared. There are subtypes of DefaultTypeHierarchy that need to customize the handling of type arguments. This method provides a convenient extension point.

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>

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>

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_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>

visitIntersectionSupertype

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

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

visitTypevarSupertype

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

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

visitTypevarSubtype

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

A type variable is a subtype if its upper bounds is below the supertype. Note: When comparing two type variables this method and visitTypevarSupertype will combine to isValid the subtypes upper bound against the supertypes lower bound.

visitUnionSubtype

protected Boolean visitUnionSubtype(AnnotatedTypeMirror.AnnotatedUnionType subtype,
                                    AnnotatedTypeMirror supertype)

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

visitWildcardSupertype

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

visitWildcardSubtype

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

castedAsSuper

public static <T extends AnnotatedTypeMirror> T castedAsSuper(AnnotatedTypeMirror subtype,
                                                              T supertype)

Calls asSuper and casts the result to the same type as the input supertype.

Type Parameters:

T - the type of supertype and return type

Parameters:

subtype - subtype to be transformed to supertype

supertype - supertype that subtype is transformed to

Returns:

subtype as an instance of supertype