org.checkerframework.framework.type

Class SubtypeVisitHistory

java.lang.Object

org.checkerframework.framework.type.SubtypeVisitHistory

public class SubtypeVisitHistory
extends Object

THIS CLASS IS DESIGNED FOR USE WITH DefaultTypeHierarchy, DefaultRawnessComparer, and StructuralEqualityComparer ONLY.

VisitHistory keeps track of all visits and allows clients of this class to check whether or not they have visited an equivalent pair of AnnotatedTypeMirrors already. This is necessary in order to halt visiting on recursive bounds.

This class is primarily used to implement isSubtype(ATM, ATM). The pair of types corresponds to the subtype and the supertype being checked. A single subtype may be visited more than once, but with a different supertype. For example, if the two types are @A T extends @B Serializable<T> and @C Serializable<?>, then isSubtype is first called one those types and then on @B Serializable<T> and @C Serializable<?>.

Constructor Summary

Constructors

Constructor and Description
SubtypeVisitHistory()

Method Summary

Modifier and Type	Method and Description
void	add(AnnotatedTypeMirror type1, AnnotatedTypeMirror type2, AnnotationMirror currentTop, Boolean b) Add a visit for type1 and type2.
boolean	contains(AnnotatedTypeMirror type1, AnnotatedTypeMirror type2, AnnotationMirror currentTop) Returns true if type1 and type2 (or an equivalent pair) have been passed to the add method previously.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SubtypeVisitHistory

public SubtypeVisitHistory()

Method Detail

add

public void add(AnnotatedTypeMirror type1,
                AnnotatedTypeMirror type2,
                AnnotationMirror currentTop,
                Boolean b)

Add a visit for type1 and type2.

contains

public boolean contains(AnnotatedTypeMirror type1,
                        AnnotatedTypeMirror type2,
                        AnnotationMirror currentTop)

Returns true if type1 and type2 (or an equivalent pair) have been passed to the add method previously.

Returns:

true if an equivalent pair has already been added to the history

toString

public String toString()

Overrides:

toString in class Object