Package org.checkerframework.framework.type.typeannotator

Class TypeAnnotator

java.lang.Object

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

org.checkerframework.framework.type.typeannotator.TypeAnnotator

All Implemented Interfaces:

AnnotatedTypeVisitor<Void,Void>

Direct Known Subclasses:

DefaultForTypeAnnotator, DefaultQualifierForUseTypeAnnotator, InitializationAnnotatedTypeFactory.CommitmentTypeAnnotator, IrrelevantTypeAnnotator, ListTypeAnnotator, MustCallTypeAnnotator, PropagationTypeAnnotator

public abstract class TypeAnnotator
extends AnnotatedTypeScanner<Void,Void>

TypeAnnotator is an abstract AnnotatedTypeScanner to be used with ListTypeAnnotator.

See Also:

• ListTypeAnnotator
• PropagationTypeAnnotator
• DefaultForTypeAnnotator

Nested Class Summary

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

AnnotatedTypeScanner.Reduce<R>

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnnotatedTypeFactory	atypeFactory	The type factory.

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

defaultResult, reduceFunction, visitedNodes

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TypeAnnotator(AnnotatedTypeFactory atypeFactory)	Creates a new TypeAnnotator.

Method Summary

Modifier and Type	Method	Description
Void	visitExecutable(AnnotatedTypeMirror.AnnotatedExecutableType method, Void aVoid)	Visits an executable type.

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

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

Methods inherited from class java.lang.Object

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

Field Details

atypeFactory

protected final AnnotatedTypeFactory atypeFactory

The type factory.

Constructor Details

TypeAnnotator

protected TypeAnnotator(AnnotatedTypeFactory atypeFactory)

Creates a new TypeAnnotator.

Parameters:

atypeFactory - the type factory

Method Details

visitExecutable

public Void visitExecutable(AnnotatedTypeMirror.AnnotatedExecutableType method,
 Void aVoid)

Visits an executable type.

If this method adds annotations to the type of method parameters, then GenericAnnotatedTypeFactory.addComputedTypeAnnotations(Element, AnnotatedTypeMirror) should be overridden and the same annotations added to the type of elements with kind ElementKind.PARAMETER. Likewise for return types.

Specified by:

visitExecutable in interface AnnotatedTypeVisitor<Void,Void>

Overrides:

visitExecutable in class AnnotatedTypeScanner<Void,Void>

Parameters:

method - the type to visit

aVoid - a visitor-specified parameter

Returns:

a visitor-specified result