Package org.checkerframework.framework.type

Class AnnotatedTypeFactory.CapturedTypeVarSubstitutor

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeCopier

org.checkerframework.framework.type.AnnotatedTypeFactory.CapturedTypeVarSubstitutor

All Implemented Interfaces:

AnnotatedTypeVisitor<AnnotatedTypeMirror,IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror>>

Enclosing class:

AnnotatedTypeFactory

public static class AnnotatedTypeFactory.CapturedTypeVarSubstitutor
extends AnnotatedTypeCopier

Substitutes references to captured types in type using capturedTypeVarToAnnotatedTypeVar.

Unlike AnnotatedTypeFactory.typeVarSubstitutor, this class does not copy the type. Call substitute to use.

Field Summary

Fields inherited from class org.checkerframework.framework.type.AnnotatedTypeCopier

copyAnnotations, visitingExecutableTypeParam

Constructor Summary

Constructors

Constructor	Description
CapturedTypeVarSubstitutor()	Creates a CapturedTypeVarSubstitutor.

Method Summary

Modifier and Type	Method	Description
protected <T extends AnnotatedTypeMirror> T	makeOrReturnCopy(T original, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	For any given object in the type being copied, we only want to generate one copy of that object.
void	substitute(AnnotatedTypeMirror.AnnotatedTypeVariable type, Map<TypeVariable,AnnotatedTypeMirror.AnnotatedTypeVariable> capturedTypeVarToAnnotatedTypeVar)	Substitutes references to captured type variable in type using capturedTypeVarToAnnotatedTypeVar.
AnnotatedTypeMirror	visitTypeVariable(AnnotatedTypeMirror.AnnotatedTypeVariable original, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	Visits a type variable.

Methods inherited from class org.checkerframework.framework.type.AnnotatedTypeCopier

makeCopy, maybeCopyPrimaryAnnotations, visit, visit, visitArray, visitDeclared, visitExecutable, visitIntersection, visitNoType, visitNull, visitPrimitive, visitUnion, visitWildcard

Methods inherited from class java.lang.Object

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

Constructor Details

CapturedTypeVarSubstitutor

public CapturedTypeVarSubstitutor()

Creates a CapturedTypeVarSubstitutor.

Method Details

substitute

public void substitute(AnnotatedTypeMirror.AnnotatedTypeVariable type,
 Map<TypeVariable,AnnotatedTypeMirror.AnnotatedTypeVariable> capturedTypeVarToAnnotatedTypeVar)

Substitutes references to captured type variable in type using capturedTypeVarToAnnotatedTypeVar.

Unlike AnnotatedTypeFactory.typeVarSubstitutor, this method does not copy the type.

Parameters:

type - the type whose captured type variables are substituted with those in capturedTypeVarToAnnotatedTypeVar

capturedTypeVarToAnnotatedTypeVar - mapping from a TypeVariable (which is a captured type variable) to an AnnotatedTypeVariable

visitTypeVariable

public AnnotatedTypeMirror visitTypeVariable(AnnotatedTypeMirror.AnnotatedTypeVariable original,
 IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)

Description copied from interface: AnnotatedTypeVisitor

Visits a type variable.

Specified by:

visitTypeVariable in interface AnnotatedTypeVisitor<AnnotatedTypeMirror,IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror>>

Overrides:

visitTypeVariable in class AnnotatedTypeCopier

Parameters:

original - the type to visit

originalToCopy - a visitor-specified parameter

Returns:

a visitor-specified result

makeOrReturnCopy

protected <T extends AnnotatedTypeMirror> T makeOrReturnCopy(T original,
 IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)

Description copied from class: AnnotatedTypeCopier

For any given object in the type being copied, we only want to generate one copy of that object. When that object is encountered again, using the previously generated copy will preserve the structure of the original AnnotatedTypeMirror.

makeOrReturnCopy first checks to see if an object has been encountered before. If so, it returns the previously generated duplicate of that object if not, it creates a duplicate of the object and stores it in the history, originalToCopy

Overrides:

makeOrReturnCopy in class AnnotatedTypeCopier

Type Parameters:

T - the type of original copy, this is a shortcut to avoid having to insert casts all over the visitor

Parameters:

original - a reference to a type to copy

originalToCopy - a mapping of previously encountered references to the copies made for those references

Returns:

a copy of original