org.checkerframework.framework.type.typeannotator

Class DefaultQualifierForUseTypeAnnotator

java.lang.Object

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

org.checkerframework.framework.type.typeannotator.TypeAnnotator

org.checkerframework.framework.type.typeannotator.DefaultQualifierForUseTypeAnnotator

All Implemented Interfaces:

AnnotatedTypeVisitor<Void,Void>

public class DefaultQualifierForUseTypeAnnotator
extends TypeAnnotator

Implements support for DefaultQualifierForUse and NoDefaultQualifierForUse.

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 and Description
protected Map<Element,Set<AnnotationMirror>>	elementToDefaults Cache of elements to the set of annotations that should be applied to unannotated uses of the element.

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

typeFactory

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

defaultResult, reduceFunction, visitedNodes

Constructor Summary

Constructors

Constructor and Description
DefaultQualifierForUseTypeAnnotator(AnnotatedTypeFactory typeFactory) Creates an DefaultQualifierForUseTypeAnnotator for typeFactory

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clears all caches.
protected Set<AnnotationMirror>	getDefaultAnnosForUses(Element element) Returns the set of qualifiers that should be applied to unannotated uses of this element.
protected Set<AnnotationMirror>	getExplicitAnnos(Element element) Return the annotations explicitly written on the element.
protected Set<AnnotationMirror>	getHierarchiesNoDefault(Element element) Returns top annotations in hierarchies for which no default for use qualifier should be added.
protected Set<AnnotationMirror>	getSupportAnnosFromDefaultQualifierForUses(Element element) Return the default qualifiers for uses of element as specified by DefaultQualifierForUse annotation.
protected AnnotationMirrorSet	supportedAnnosFromAnnotationMirror(AnnotationMirror annotationMirror) Returns the set of qualifiers supported by this type system from the value element of annotationMirror.
Void	visitDeclared(AnnotatedTypeMirror.AnnotatedDeclaredType type, Void aVoid) Visits a declared type.

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

visitExecutable

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

reduce, reset, scan, scan, scanAndReduce, scanAndReduce, visit, visit, visitArray, 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 Detail

elementToDefaults

protected Map<Element,Set<AnnotationMirror>> elementToDefaults

Cache of elements to the set of annotations that should be applied to unannotated uses of the element.

Constructor Detail

DefaultQualifierForUseTypeAnnotator

public DefaultQualifierForUseTypeAnnotator(AnnotatedTypeFactory typeFactory)

Creates an DefaultQualifierForUseTypeAnnotator for typeFactory

Method Detail

visitDeclared

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

Description copied from interface: AnnotatedTypeVisitor

Visits a declared type.

Specified by:

visitDeclared in interface AnnotatedTypeVisitor<Void,Void>

Overrides:

visitDeclared in class AnnotatedTypeScanner<Void,Void>

Parameters:

type - the type to visit

aVoid - a visitor-specified parameter

Returns:

a visitor-specified result

clearCache

public void clearCache()

Clears all caches.

getDefaultAnnosForUses

protected Set<AnnotationMirror> getDefaultAnnosForUses(Element element)

Returns the set of qualifiers that should be applied to unannotated uses of this element.

getExplicitAnnos

protected Set<AnnotationMirror> getExplicitAnnos(Element element)

Return the annotations explicitly written on the element.

getSupportAnnosFromDefaultQualifierForUses

protected Set<AnnotationMirror> getSupportAnnosFromDefaultQualifierForUses(Element element)

Return the default qualifiers for uses of element as specified by DefaultQualifierForUse annotation.

Subclass may override to use an annotation other than DefaultQualifierForUse.

getHierarchiesNoDefault

protected Set<AnnotationMirror> getHierarchiesNoDefault(Element element)

Returns top annotations in hierarchies for which no default for use qualifier should be added.

supportedAnnosFromAnnotationMirror

protected final AnnotationMirrorSet supportedAnnosFromAnnotationMirror(AnnotationMirror annotationMirror)

Returns the set of qualifiers supported by this type system from the value element of annotationMirror.

Parameters:

annotationMirror - a non-null annotation with a value element that is an array of annotation classes

Returns:

the set of qualifiers supported by this type system from the value element of annotationMirror