Package org.checkerframework.framework.type

Class AnnotatedTypeReplacer

java.lang.Object

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

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

org.checkerframework.framework.type.AnnotatedTypeReplacer

All Implemented Interfaces:

AnnotatedTypeVisitor<Void,AnnotatedTypeMirror>

public class AnnotatedTypeReplacer
extends DoubleAnnotatedTypeScanner<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	Description
AnnotatedTypeReplacer()	Construct an AnnotatedTypeReplacer that will replace all annotations.
AnnotatedTypeReplacer(@Nullable AnnotationMirror top)	Construct an AnnotatedTypeReplacer that will only replace annotations in top's hierarchy.

Method Summary

Modifier and Type	Method	Description
protected Void	defaultAction(AnnotatedTypeMirror from, AnnotatedTypeMirror to)	Called by default for any visit method that is not overridden.
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	setTop(@Nullable AnnotationMirror top)	If top != null, then only annotations in the hierarchy of top are affected; otherwise, all annotations are replaced.
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.DoubleAnnotatedTypeScanner

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

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

reduce, 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 Details

AnnotatedTypeReplacer

public AnnotatedTypeReplacer()

Construct an AnnotatedTypeReplacer that will replace all annotations.

AnnotatedTypeReplacer

public AnnotatedTypeReplacer(@Nullable AnnotationMirror top)

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

Parameters:

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

Method Details

setTop

public void setTop(@Nullable AnnotationMirror top)

If top != null, then only annotations in the hierarchy of top are affected; otherwise, all annotations are replaced.

Parameters:

top - if top != null, then only annotations in the hierarchy of top are replaced; otherwise, all annotations are replaced.

defaultAction

protected Void defaultAction(AnnotatedTypeMirror from,
 AnnotatedTypeMirror to)

Description copied from class: DoubleAnnotatedTypeScanner

Called by default for any visit method that is not overridden.

Specified by:

defaultAction in class DoubleAnnotatedTypeScanner<Void>

Parameters:

from - the type to visit

to - a visitor-specified parameter

Returns:

a visitor-specified result

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