Package org.checkerframework.framework.type

Class AnnotatedTypeCopier

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeCopier

All Implemented Interfaces:

AnnotatedTypeVisitor<AnnotatedTypeMirror,IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror>>

Direct Known Subclasses:

AnnotatedTypeCopierWithReplacement.Visitor, TypeVariableSubstitutor.Visitor

public class AnnotatedTypeCopier
extends Object
implements AnnotatedTypeVisitor<AnnotatedTypeMirror,IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror>>

AnnotatedTypeCopier is a visitor that deep copies an AnnotatedTypeMirror exactly, including any lazily initialized fields. That is, if a field has already been initialized, it will be initialized in the copied type.

When making copies, a map of encountered references => copied types is maintained. This ensures that, if a reference appears in multiple locations in the original type, a corresponding copy of the original type appears in the same locations in the output copy. This ensures that the recursive loops in the input type are preserved in its output copy (see makeOrReturnCopy)

In general, AnnotatedTypeMirrors should be copied via AnnotatedTypeMirror#deepCopy and AnnotatedTypeMirror#shallowCopy. AnnotatedTypeMirror#deepCopy makes use of AnnotatedTypeCopier under the covers. However, this visitor and its subclasses can be invoked as follows:

new AnnotatedTypeCopier().visit(myTypeVar);

Note: There are methods that may require a copy of a type mirror with slight changes. It is intended that this class can be overridden for these cases.

See Also:

• TypeVariableSubstitutor
• AnnotatedTypeCopierWithReplacement

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	copyAnnotations	See AnnotatedTypeCopier(boolean).
protected boolean	visitingExecutableTypeParam	This is a hack to handle the curious behavior of substitution on an AnnotatedExecutableType.

Constructor Summary

Constructors

Constructor	Description
AnnotatedTypeCopier()	Creates an AnnotatedTypeCopier that copies both the structure and annotations of the source AnnotatedTypeMirror.
AnnotatedTypeCopier(boolean copyAnnotations)	Creates an AnnotatedTypeCopier that may or may not copyAnnotations By default AnnotatedTypeCopier provides two major properties in its copies: Structure preservation -- the exact structure of the original AnnotatedTypeMirror is preserved in the copy including all component types.

Method Summary

Modifier and Type	Method	Description
protected <T extends AnnotatedTypeMirror> T	makeCopy(T original)	Returns a copy of the given type.
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.
protected void	maybeCopyPrimaryAnnotations(AnnotatedTypeMirror source, AnnotatedTypeMirror dest)	This method is called in any location in which a primary annotation would be copied from source to dest.
AnnotatedTypeMirror	visit(AnnotatedTypeMirror type)	A convenience method equivalent to v.visit(t, null).
AnnotatedTypeMirror	visit(AnnotatedTypeMirror type, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	Visits a type.
AnnotatedTypeMirror	visitArray(AnnotatedTypeMirror.AnnotatedArrayType original, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	Visits an array type.
AnnotatedTypeMirror	visitDeclared(AnnotatedTypeMirror.AnnotatedDeclaredType original, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	Visits a declared type.
AnnotatedTypeMirror	visitExecutable(AnnotatedTypeMirror.AnnotatedExecutableType original, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	Visits an executable type.
AnnotatedTypeMirror	visitIntersection(AnnotatedTypeMirror.AnnotatedIntersectionType original, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	Visits an intersection type.
AnnotatedTypeMirror	visitNoType(AnnotatedTypeMirror.AnnotatedNoType original, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	Visits NoType type.
AnnotatedTypeMirror	visitNull(AnnotatedTypeMirror.AnnotatedNullType original, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	Visits a null type.
AnnotatedTypeMirror	visitPrimitive(AnnotatedTypeMirror.AnnotatedPrimitiveType original, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	Visits a primitive type.
AnnotatedTypeMirror	visitTypeVariable(AnnotatedTypeMirror.AnnotatedTypeVariable original, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	Visits a type variable.
AnnotatedTypeMirror	visitUnion(AnnotatedTypeMirror.AnnotatedUnionType original, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	Visits an union type.
AnnotatedTypeMirror	visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType original, IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)	Visits a wildcard type.

Methods inherited from class java.lang.Object

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

Field Details

visitingExecutableTypeParam

protected boolean visitingExecutableTypeParam

This is a hack to handle the curious behavior of substitution on an AnnotatedExecutableType.

See Also:

• It is poor form to include such a flag on the base class for exclusive use in a subclass but it is the least bad option in this case.

copyAnnotations

protected final boolean copyAnnotations

See AnnotatedTypeCopier(boolean).

See Also:

• AnnotatedTypeCopier(boolean)

Constructor Details

AnnotatedTypeCopier

public AnnotatedTypeCopier(boolean copyAnnotations)

Creates an AnnotatedTypeCopier that may or may not copyAnnotations By default AnnotatedTypeCopier provides two major properties in its copies:

1. Structure preservation -- the exact structure of the original AnnotatedTypeMirror is preserved in the copy including all component types.
2. Annotation preservation -- All of the annotations from the original AnnotatedTypeMirror and its components have been copied to the new type.

If copyAnnotations is set to false, the second property, annotation preservation, is removed. This is useful for cases in which the user may want to copy the structure of a type exactly but NOT its annotations.

AnnotatedTypeCopier

public AnnotatedTypeCopier()

Creates an AnnotatedTypeCopier that copies both the structure and annotations of the source AnnotatedTypeMirror.

See Also:

• AnnotatedTypeCopier(boolean)

Method Details

visit

public AnnotatedTypeMirror visit(AnnotatedTypeMirror type)

Description copied from interface: AnnotatedTypeVisitor

A convenience method equivalent to v.visit(t, null).

Specified by:

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

Parameters:

type - the type to visit

Returns:

a visitor-specified result

visit

public AnnotatedTypeMirror visit(AnnotatedTypeMirror type,
 IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)

Description copied from interface: AnnotatedTypeVisitor

Visits a type.

Specified by:

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

Parameters:

type - the type to visit

originalToCopy - a visitor-specified parameter

Returns:

a visitor-specified result

visitDeclared

public AnnotatedTypeMirror visitDeclared(AnnotatedTypeMirror.AnnotatedDeclaredType original,
 IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)

Description copied from interface: AnnotatedTypeVisitor

Visits a declared type.

Specified by:

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

Parameters:

original - the type to visit

originalToCopy - a visitor-specified parameter

Returns:

a visitor-specified result

visitIntersection

public AnnotatedTypeMirror visitIntersection(AnnotatedTypeMirror.AnnotatedIntersectionType original,
 IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)

Description copied from interface: AnnotatedTypeVisitor

Visits an intersection type.

Specified by:

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

Parameters:

original - the type to visit

originalToCopy - a visitor-specified parameter

Returns:

a visitor-specified result

visitUnion

public AnnotatedTypeMirror visitUnion(AnnotatedTypeMirror.AnnotatedUnionType original,
 IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)

Description copied from interface: AnnotatedTypeVisitor

Visits an union type.

Specified by:

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

Parameters:

original - the type to visit

originalToCopy - a visitor-specified parameter

Returns:

a visitor-specified result

visitExecutable

public AnnotatedTypeMirror visitExecutable(AnnotatedTypeMirror.AnnotatedExecutableType original,
 IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)

Description copied from interface: AnnotatedTypeVisitor

Visits an executable type.

Specified by:

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

Parameters:

original - the type to visit

originalToCopy - a visitor-specified parameter

Returns:

a visitor-specified result

visitArray

public AnnotatedTypeMirror visitArray(AnnotatedTypeMirror.AnnotatedArrayType original,
 IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)

Description copied from interface: AnnotatedTypeVisitor

Visits an array type.

Specified by:

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

Parameters:

original - the type to visit

originalToCopy - a visitor-specified parameter

Returns:

a visitor-specified result

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

Parameters:

original - the type to visit

originalToCopy - a visitor-specified parameter

Returns:

a visitor-specified result

visitPrimitive

public AnnotatedTypeMirror visitPrimitive(AnnotatedTypeMirror.AnnotatedPrimitiveType original,
 IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)

Description copied from interface: AnnotatedTypeVisitor

Visits a primitive type.

Specified by:

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

Parameters:

original - the type to visit

originalToCopy - a visitor-specified parameter

Returns:

a visitor-specified result

visitNoType

public AnnotatedTypeMirror visitNoType(AnnotatedTypeMirror.AnnotatedNoType original,
 IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)

Description copied from interface: AnnotatedTypeVisitor

Visits NoType type.

Specified by:

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

Parameters:

original - the type to visit

originalToCopy - a visitor-specified parameter

Returns:

a visitor-specified result

visitNull

public AnnotatedTypeMirror visitNull(AnnotatedTypeMirror.AnnotatedNullType original,
 IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)

Description copied from interface: AnnotatedTypeVisitor

Visits a null type.

Specified by:

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

Parameters:

original - the type to visit

originalToCopy - a visitor-specified parameter

Returns:

a visitor-specified result

visitWildcard

public AnnotatedTypeMirror visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType original,
 IdentityHashMap<AnnotatedTypeMirror,AnnotatedTypeMirror> originalToCopy)

Description copied from interface: AnnotatedTypeVisitor

Visits a wildcard type.

Specified by:

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

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)

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

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

makeCopy

protected <T extends AnnotatedTypeMirror> T makeCopy(T original)

Returns a copy of the given type.

Type Parameters:

T - the type of the AnnotatedTypeMirror to copy

Parameters:

original - an AnnotatedTypeMirror (more specifically, a T)

Returns:

a copy of the given AnnotatedTypeMirror

maybeCopyPrimaryAnnotations

protected void maybeCopyPrimaryAnnotations(AnnotatedTypeMirror source,
 AnnotatedTypeMirror dest)

This method is called in any location in which a primary annotation would be copied from source to dest. Note, this method obeys the copyAnnotations field. Subclasses of AnnotatedTypeCopier can use this method to customize annotations before copying.

Parameters:

source - the type whose primary annotations are being copied

dest - a copy of source that should receive its primary annotations