org.checkerframework.framework.type.typeannotator

Class DefaultForTypeAnnotator

java.lang.Object

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

org.checkerframework.framework.type.typeannotator.TypeAnnotator

org.checkerframework.framework.type.typeannotator.DefaultForTypeAnnotator

All Implemented Interfaces:

AnnotatedTypeVisitor<java.lang.Void,java.lang.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

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
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 and Description
void	addAtmClass(java.lang.Class<? extends AnnotatedTypeMirror> typeClass, javax.lang.model.element.AnnotationMirror theQual) Add default qualifier, theQual, for the given AnnotatedTypeMirror class.
DefaultForTypeAnnotator	addStandardDefaults() Adds standard rules.
void	addTypeKind(javax.lang.model.type.TypeKind typeKind, javax.lang.model.element.AnnotationMirror theQual) Add default qualifier, theQual, for the given TypeKind.
void	addTypes(java.lang.Class<?> clazz, javax.lang.model.element.AnnotationMirror theQual) Add default qualifier, theQual, for the given type.
protected java.lang.Void	scan(AnnotatedTypeMirror type, java.lang.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

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 Detail

addTypeKind

public void addTypeKind(javax.lang.model.type.TypeKind typeKind,
                        javax.lang.model.element.AnnotationMirror theQual)

Add default qualifier, theQual, for the given TypeKind.

addAtmClass

public void addAtmClass(java.lang.Class<? extends AnnotatedTypeMirror> typeClass,
                        javax.lang.model.element.AnnotationMirror theQual)

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

addTypes

public void addTypes(java.lang.Class<?> clazz,
                     javax.lang.model.element.AnnotationMirror theQual)

Add default qualifier, theQual, for the given type.

scan

protected java.lang.Void scan(AnnotatedTypeMirror type,
                              java.lang.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<java.lang.Void,java.lang.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