org.checkerframework.framework.type.visitor

Class AnnotatedTypeMerger

java.lang.Object

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

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

org.checkerframework.framework.type.visitor.AnnotatedTypeMerger

All Implemented Interfaces:

AnnotatedTypeVisitor<Void,AnnotatedTypeMirror>

public class AnnotatedTypeMerger
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 AnnotatedTypesMerger(), parameter);
 

Author:

smillst

Field Summary

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

visitedNodes

Constructor Summary

Constructors

Constructor and Description
AnnotatedTypeMerger()
AnnotatedTypeMerger(AnnotationMirror top)

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 one, AnnotatedTypeMirror two) Compares two annotated type mirrors.
static void	merge(AnnotatedTypeMirror from, AnnotatedTypeMirror to)
static void	merge(AnnotatedTypeMirror from, AnnotatedTypeMirror to, AnnotationMirror top)
protected void	replaceAnnotations(AnnotatedTypeMirror one, AnnotatedTypeMirror two)
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

AnnotatedTypeMerger

public AnnotatedTypeMerger()

AnnotatedTypeMerger

public AnnotatedTypeMerger(AnnotationMirror top)

Parameters:

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

Method Detail

merge

public static void merge(AnnotatedTypeMirror from,
                         AnnotatedTypeMirror to)

merge

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

compare

protected Void compare(AnnotatedTypeMirror one,
                       AnnotatedTypeMirror two)

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 one,
                                  AnnotatedTypeMirror two)

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