Class SubtypeVisitHistory
- java.lang.Object
-
- org.checkerframework.framework.type.SubtypeVisitHistory
-
public class SubtypeVisitHistory extends java.lang.Object
THIS CLASS IS DESIGNED FOR USE WITH DefaultTypeHierarchy, DefaultRawnessComparer, and StructuralEqualityComparer ONLY.VisitHistory tracks triples of (type1, type2, top), where type1 is a subtype of type2. It does not track when type1 is not a subtype of type2; such entries are missing from the history. Clients of this class can 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 Description SubtypeVisitHistory()
Creates a new SubtypeVisitHistory.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
contains(AnnotatedTypeMirror type1, AnnotatedTypeMirror type2, javax.lang.model.element.AnnotationMirror currentTop)
Returns true if type1 and type2 (or an equivalent pair) have been passed to the put method previously.void
put(AnnotatedTypeMirror type1, AnnotatedTypeMirror type2, javax.lang.model.element.AnnotationMirror currentTop, boolean isSubtype)
Put a visit fortype1
,type2
, andtop
in the history.void
remove(AnnotatedTypeMirror type1, AnnotatedTypeMirror type2, javax.lang.model.element.AnnotationMirror currentTop)
Removetype1
andtype2
.java.lang.String
toString()
-
-
-
Method Detail
-
put
public void put(AnnotatedTypeMirror type1, AnnotatedTypeMirror type2, javax.lang.model.element.AnnotationMirror currentTop, boolean isSubtype)
Put a visit fortype1
,type2
, andtop
in the history. Has no effect if isSubtype is false.- Parameters:
type1
- the first typetype2
- the second typecurrentTop
- the top of the relevant type hierarchy; only annotations from that hierarchy are consideredisSubtype
- whethertype1
is a subtype oftype2
; if false, this method does nothing
-
remove
public void remove(AnnotatedTypeMirror type1, AnnotatedTypeMirror type2, javax.lang.model.element.AnnotationMirror currentTop)
Removetype1
andtype2
.
-
contains
public boolean contains(AnnotatedTypeMirror type1, AnnotatedTypeMirror type2, javax.lang.model.element.AnnotationMirror currentTop)
Returns true if type1 and type2 (or an equivalent pair) have been passed to the put method previously.- Returns:
- true if an equivalent pair has already been added to the history
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-