org.checkerframework.framework.type.typeannotator

Class ImplicitsTypeAnnotator

java.lang.Object

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

org.checkerframework.framework.type.typeannotator.TypeAnnotator

org.checkerframework.framework.type.typeannotator.ImplicitsTypeAnnotator

All Implemented Interfaces:

AnnotatedTypeVisitor<Void,Void>

public class ImplicitsTypeAnnotator
extends TypeAnnotator

Adds annotations to a type based on the contents of a type. By default, this class honors the ImplicitFor annotation and applies implicit annotations specified by ImplicitFor for any type whose visitor is not overridden or does not call super; it is designed to be invoked from AnnotatedTypeFactory.addComputedTypeAnnotations(Element, org.checkerframework.framework.type.AnnotatedTypeMirror) and AnnotatedTypeFactory.addComputedTypeAnnotations(Tree, org.checkerframework.framework.type.AnnotatedTypeMirror).

ImplicitsTypeAnnotator traverses types deeply by default, except that it skips the method receiver of executable types (for interoperability with AnnotatedTypeFactory.annotateInheritedFromClass(org.checkerframework.framework.type.AnnotatedTypeMirror)).

This class takes care of two of the attributes of ImplicitFor; the others are handled in TreeAnnotator.

See Also:

TreeAnnotator

Field Summary

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

typeFactory

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

visitedNodes

Constructor Summary

Constructors

Constructor and Description
ImplicitsTypeAnnotator(AnnotatedTypeFactory typeFactory) Creates a ImplicitsTypeAnnotator from the given checker, using that checker to determine the annotations that are in the type hierarchy.

Method Summary

Modifier and Type	Method and Description
void	addTypeClass(Class<? extends AnnotatedTypeMirror> typeClass, AnnotationMirror theQual)
void	addTypeKind(TypeKind typeKind, AnnotationMirror theQual)
void	addTypeName(Class<?> typeName, AnnotationMirror theQual)
protected Void	scan(AnnotatedTypeMirror type, Void p) Scan type by calling type.accept(this, p); this method may be overridden by subclasses.

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

visitExecutable

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

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

Constructor Detail

ImplicitsTypeAnnotator

public ImplicitsTypeAnnotator(AnnotatedTypeFactory typeFactory)

Creates a ImplicitsTypeAnnotator from the given checker, using that checker to determine the annotations that are in the type hierarchy.

Method Detail

addTypeKind

public void addTypeKind(TypeKind typeKind,
                        AnnotationMirror theQual)

addTypeClass

public void addTypeClass(Class<? extends AnnotatedTypeMirror> typeClass,
                         AnnotationMirror theQual)

addTypeName

public void addTypeName(Class<?> typeName,
                        AnnotationMirror theQual)

scan

protected Void scan(AnnotatedTypeMirror type,
                    Void p)

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

p - the parameter to use

Returns:

the result of visiting type