Package org.checkerframework.framework.type.typeannotator

Class PropagationTypeAnnotator

java.lang.Object

org.checkerframework.framework.type.visitor.AnnotatedTypeScanner<Void,Void>

org.checkerframework.framework.type.typeannotator.TypeAnnotator

org.checkerframework.framework.type.typeannotator.PropagationTypeAnnotator

All Implemented Interfaces:

AnnotatedTypeVisitor<Void,Void>

public class PropagationTypeAnnotator
extends TypeAnnotator

PropagationTypeAnnotator adds qualifiers to types where the qualifier to add should be transferred from one or more other types.

At the moment, the only function PropagationTypeAnnotator provides, is the propagation of generic type parameter annotations to unannotated wildcards with missing bounds annotations.

See Also:

• PropagationTypeAnnotator traverses trees deeply by default.

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.typeannotator.TypeAnnotator

atypeFactory

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

defaultResult, reduceFunction, visitedNodes

Constructor Summary

Constructors

Constructor	Description
PropagationTypeAnnotator(AnnotatedTypeFactory typeFactory)	Creates a new PropagationTypeAnnotator.

Method Summary

Modifier and Type	Method	Description
void	reset()	Reset the scanner to allow reuse of the same instance.
protected Void	scan(AnnotatedTypeMirror type, Void aVoid)	Scan type by calling type.accept(this, p); this method may be overridden by subclasses.
Void	visitDeclared(AnnotatedTypeMirror.AnnotatedDeclaredType declaredType, Void aVoid)	Sometimes the underlying type parameters of AnnotatedWildcardTypes are not available on the wildcards themselves.
Void	visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType wildcard, Void aVoid)	Rather than defaulting the missing bounds of a wildcard, find the bound annotations on the type parameter it replaced.

Methods inherited from class org.checkerframework.framework.type.typeannotator.TypeAnnotator

visitExecutable

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

reduce, scan, scanAndReduce, scanAndReduce, visit, visit, visitArray, visitIntersection, visitNoType, visitNull, visitPrimitive, visitTypeVariable, visitUnion

Methods inherited from class java.lang.Object

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

Constructor Details

PropagationTypeAnnotator

public PropagationTypeAnnotator(AnnotatedTypeFactory typeFactory)

Creates a new PropagationTypeAnnotator.

Parameters:

typeFactory - the type factory

Method Details

reset

public void reset()

Description copied from class: AnnotatedTypeScanner

Reset the scanner to allow reuse of the same instance. Subclasses should override this method to clear their additional state; they must call the super implementation.

Overrides:

reset in class AnnotatedTypeScanner<Void,Void>

scan

protected Void scan(AnnotatedTypeMirror type,
 Void aVoid)

Description copied from class: AnnotatedTypeScanner

Scan type by calling type.accept(this, p); this method may be overridden by subclasses.

Overrides:

scan in class AnnotatedTypeScanner<Void,Void>

Parameters:

type - type to scan

aVoid - the parameter to use

Returns:

the result of visiting type

visitDeclared

public Void visitDeclared(AnnotatedTypeMirror.AnnotatedDeclaredType declaredType,
 Void aVoid)

Sometimes the underlying type parameters of AnnotatedWildcardTypes are not available on the wildcards themselves. Instead, record enclosing class to find the type parameter to use as a backup in visitWildcards.

Specified by:

visitDeclared in interface AnnotatedTypeVisitor<Void,Void>

Overrides:

visitDeclared in class AnnotatedTypeScanner<Void,Void>

Parameters:

declaredType - type to record

aVoid - a visitor-specified parameter

Returns:

a visitor-specified result

visitWildcard

public Void visitWildcard(AnnotatedTypeMirror.AnnotatedWildcardType wildcard,
 Void aVoid)

Rather than defaulting the missing bounds of a wildcard, find the bound annotations on the type parameter it replaced. Place those annotations on the wildcard.

Specified by:

visitWildcard in interface AnnotatedTypeVisitor<Void,Void>

Overrides:

visitWildcard in class AnnotatedTypeScanner<Void,Void>

Parameters:

wildcard - type to annotate

aVoid - a visitor-specified parameter

Returns:

a visitor-specified result