Package org.checkerframework.framework.type.typeannotator

Class DefaultForTypeAnnotator

java.lang.Object

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

org.checkerframework.framework.type.typeannotator.TypeAnnotator

org.checkerframework.framework.type.typeannotator.DefaultForTypeAnnotator

All Implemented Interfaces:

AnnotatedTypeVisitor<Void,Void>

public class DefaultForTypeAnnotator
extends TypeAnnotator

Adds annotations to a type based on the use of a type. This class applies annotations specified by DefaultFor; it is designed to be used in a ListTypeAnnotator constructed in GenericAnnotatedTypeFactory.createTypeAnnotator() ()}

DefaultForTypeAnnotator traverses types deeply.

This class takes care of two of the attributes of DefaultFor; the others are handled in QualifierDefaults.

See Also:

• ListTypeAnnotator

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
DefaultForTypeAnnotator(AnnotatedTypeFactory typeFactory)	Creates a DefaultForTypeAnnotator from the given checker, using that checker to determine the annotations that are in the type hierarchy.

Method Summary

Modifier and Type	Method	Description
void	addAtmClass(Class<? extends AnnotatedTypeMirror> typeClass, AnnotationMirror theQual)	Add default qualifier, theQual, for the given AnnotatedTypeMirror class.
DefaultForTypeAnnotator	addStandardDefaults()	Adds standard rules.
void	addTypeKind(TypeKind typeKind, AnnotationMirror theQual)	Add default qualifier, theQual, for the given TypeKind.
void	addTypes(Class<?> clazz, AnnotationMirror theQual)	Add default qualifier, theQual, for the given type.
void	defaultTypeFromName(AnnotatedTypeMirror type, String name)	Apply defaults based on a variable name to a type.
protected Void	scan(AnnotatedTypeMirror type, Void p)	Scan type by calling type.accept(this, p); this method may be overridden by subclasses.
Void	visitExecutable(AnnotatedTypeMirror.AnnotatedExecutableType type, Void aVoid)	Visits an executable type.

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 Details

DefaultForTypeAnnotator

public DefaultForTypeAnnotator(AnnotatedTypeFactory typeFactory)

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

Method Details

addTypeKind

public void addTypeKind(TypeKind typeKind,
 AnnotationMirror theQual)

Add default qualifier, theQual, for the given TypeKind.

addAtmClass

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

Add default qualifier, theQual, for the given AnnotatedTypeMirror class.

addTypes

public void addTypes(Class<?> clazz,
 AnnotationMirror theQual)

Add default qualifier, theQual, for the given type.

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

addStandardDefaults

public DefaultForTypeAnnotator addStandardDefaults()

Adds standard rules. Currently, sets Void to bottom if no other qualifier is set for Void. Also, see LiteralTreeAnnotator.addStandardLiteralQualifiers().

Returns:

this

defaultTypeFromName

public void defaultTypeFromName(AnnotatedTypeMirror type,
 String name)

Apply defaults based on a variable name to a type.

Parameters:

type - a type to apply defaults to

name - the name of the variable that has type type, or the name of the method whose return type is type

visitExecutable

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

Description copied from class: TypeAnnotator

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 TypeAnnotator

Parameters:

type - the type to visit

aVoid - a visitor-specified parameter

Returns:

a visitor-specified result