org.checkerframework.framework.type

Class AnnotatedTypeReplacer

java.lang.Object

org.checkerframework.framework.type.visitor.AnnotatedTypeScanner<R,AnnotatedTypeMirror>

org.checkerframework.framework.type.visitor.AnnotatedTypeComparer<Void>

org.checkerframework.framework.type.AnnotatedTypeReplacer

All Implemented Interfaces:

AnnotatedTypeVisitor<Void,AnnotatedTypeMirror>

public class AnnotatedTypeReplacer
extends AnnotatedTypeComparer<Void>

Replaces or adds all the annotations in the parameter with the annotations from the visited type. An annotation is replaced if the parameter type already has an annotation in the same hierarchy at the same location as the visited type.

Example use:

 AnnotatedTypeMirror visitType = ...;
 AnnotatedTypeMirror parameter = ...;
 visitType.accept(new AnnotatedTypeReplacer(), parameter);
 

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.framework.type.visitor.AnnotatedTypeScanner

AnnotatedTypeScanner.Reduce<R>

Field Summary

Fields inherited from class org.checkerframework.framework.type.visitor.AnnotatedTypeScanner

defaultResult, reduceFunction, visitedNodes

Constructor Summary

Constructors

Constructor and Description
AnnotatedTypeReplacer() Construct an AnnotatedTypeReplacer that will replace all annotations.
AnnotatedTypeReplacer(AnnotationMirror top) Construct an AnnotatedTypeReplacer that will only replace annotations in top's hierarchy.

Method Summary

Modifier and Type	Method and Description
protected Void	combineRs(Void r1, Void r2) Supplies the logic to reduce on how to combine two R objects.
protected Void	compare(AnnotatedTypeMirror from, AnnotatedTypeMirror to) Compares two annotated type mirrors.
static void	replace(AnnotatedTypeMirror from, AnnotatedTypeMirror to) Replaces or adds all annotations from from to to.
static void	replace(AnnotatedTypeMirror from, AnnotatedTypeMirror to, AnnotationMirror top) Replaces or adds annotations in top's hierarchy from from to to.
protected void	replaceAnnotations(AnnotatedTypeMirror from, AnnotatedTypeMirror to) Replace the annotations in to with the annotations in from, wherever from has an annotation.
void	resolvePrimaries(AnnotatedTypeMirror from, AnnotatedTypeMirror to) For type variables and wildcards, the absence of a primary annotations has an implied meaning on substitution.
Void	visitTypeVariable(AnnotatedTypeMirror.AnnotatedTypeVariable from, AnnotatedTypeMirror to) Visits a type variable.
Void	visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType from, AnnotatedTypeMirror to) Visits a wildcard type.

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

reduce, scan, scan, scanAndReduce, scanAndReduce, visitArray, visitDeclared, visitExecutable, visitIntersection, visitUnion

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

reset, scan, scanAndReduce, visit, visit, visitNoType, visitNull, visitPrimitive

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedTypeReplacer

public AnnotatedTypeReplacer()

Construct an AnnotatedTypeReplacer that will replace all annotations.

AnnotatedTypeReplacer

public AnnotatedTypeReplacer(AnnotationMirror top)

Construct an AnnotatedTypeReplacer that will only replace annotations in top's hierarchy.

Parameters:

top - if top != null, then only annotation in the hierarchy of top are affected

Method Detail

replace

public static void replace(AnnotatedTypeMirror from,
                           AnnotatedTypeMirror to)

Replaces or adds all annotations from from to to. Annotations from from will be used everywhere they exist, but annotations in to will be kept anywhere that from is unannotated.

Parameters:

from - the annotated type mirror from which to take new annotations

to - the annotated type mirror to which the annotations will be added

replace

public static void replace(AnnotatedTypeMirror from,
                           AnnotatedTypeMirror to,
                           AnnotationMirror top)

Replaces or adds annotations in top's hierarchy from from to to. Annotations from from will be used everywhere they exist, but annotations in to will be kept anywhere that from is unannotated.

Parameters:

from - the annotated type mirror from which to take new annotations

to - the annotated type mirror to which the annotations will be added

top - the top type of the hierarchy whose annotations will be added

compare

protected Void compare(AnnotatedTypeMirror from,
                       AnnotatedTypeMirror to)

Description copied from class: AnnotatedTypeComparer

Compares two annotated type mirrors.

Specified by:

compare in class AnnotatedTypeComparer<Void>

combineRs

protected Void combineRs(Void r1,
                         Void r2)

Description copied from class: AnnotatedTypeComparer

Supplies the logic to reduce on how to combine two R objects.

Specified by:

combineRs in class AnnotatedTypeComparer<Void>

replaceAnnotations

protected void replaceAnnotations(AnnotatedTypeMirror from,
                                  AnnotatedTypeMirror to)

Replace the annotations in to with the annotations in from, wherever from has an annotation.

Parameters:

from - the source of the annotations

to - the destination of the annotations, modified by this method

visitTypeVariable

public Void visitTypeVariable(AnnotatedTypeMirror.AnnotatedTypeVariable from,
                              AnnotatedTypeMirror to)

Description copied from interface: AnnotatedTypeVisitor

Visits a type variable.

Specified by:

visitTypeVariable in interface AnnotatedTypeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitTypeVariable in class AnnotatedTypeComparer<Void>

Parameters:

from - the type to visit

to - a visitor-specified parameter

Returns:

a visitor-specified result

visitWildcard

public Void visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType from,
                          AnnotatedTypeMirror to)

Description copied from interface: AnnotatedTypeVisitor

Visits a wildcard type.

Specified by:

visitWildcard in interface AnnotatedTypeVisitor<Void,AnnotatedTypeMirror>

Overrides:

visitWildcard in class AnnotatedTypeComparer<Void>

Parameters:

from - the type to visit

to - a visitor-specified parameter

Returns:

a visitor-specified result

resolvePrimaries

public void resolvePrimaries(AnnotatedTypeMirror from,
                             AnnotatedTypeMirror to)

For type variables and wildcards, the absence of a primary annotations has an implied meaning on substitution. Therefore, in these cases we remove the primary annotation and rely on the fact that the bounds are also merged into the type to.

Parameters:

from - a type variable or wildcard

to - the destination annotated type mirror