org.checkerframework.javacutil

Interface AnnotationProvider

All Known Implementing Classes:

AliasingAnnotatedTypeFactory, AnnotatedTypeFactory, BaseAnnotatedTypeFactory, BasicAnnotationProvider, ClassValAnnotatedTypeFactory, CompilerMessagesAnnotatedTypeFactory, FenumAnnotatedTypeFactory, FormatterAnnotatedTypeFactory, GenericAnnotatedTypeFactory, GuiEffectTypeFactory, I18nAnnotatedTypeFactory, I18nFormatterAnnotatedTypeFactory, InitializationAnnotatedTypeFactory, InterningAnnotatedTypeFactory, KeyForAnnotatedTypeFactory, LessThanAnnotatedTypeFactory, LocalizableKeyAnnotatedTypeFactory, LockAnnotatedTypeFactory, LowerBoundAnnotatedTypeFactory, MethodValAnnotatedTypeFactory, NullnessAnnotatedTypeFactory, PropertyKeyAnnotatedTypeFactory, PurityAnnotatedTypeFactory, RegexAnnotatedTypeFactory, SameLenAnnotatedTypeFactory, SearchIndexAnnotatedTypeFactory, SignatureAnnotatedTypeFactory, SignednessAnnotatedTypeFactory, SubstringIndexAnnotatedTypeFactory, SubtypingAnnotatedTypeFactory, TypeOutputtingChecker.GeneralAnnotatedTypeFactory, UnitsAnnotatedTypeFactory, UpperBoundAnnotatedTypeFactory, ValueAnnotatedTypeFactory

public interface AnnotationProvider

An implementation of AnnotationProvider returns annotations on Java AST elements.

Method Summary

Modifier and Type	Method and Description
AnnotationMirror	getAnnotationMirror(Tree tree, Class<? extends Annotation> target) Return the annotation on tree that has the class target.
AnnotationMirror	getDeclAnnotation(Element elt, Class<? extends Annotation> anno) Returns the actual annotation mirror used to annotate this type, whose name equals the passed annotationName if one exists, null otherwise.

Method Detail

getDeclAnnotation

AnnotationMirror getDeclAnnotation(Element elt,
                                   Class<? extends Annotation> anno)

Returns the actual annotation mirror used to annotate this type, whose name equals the passed annotationName if one exists, null otherwise.

Parameters:

elt - the element

anno - annotation class

Returns:

the annotation mirror for anno

getAnnotationMirror

AnnotationMirror getAnnotationMirror(Tree tree,
                                     Class<? extends Annotation> target)

Return the annotation on tree that has the class target. If no annotation for the given target class exists, the result is null

Parameters:

tree - the tree of which the annotation is returned

target - the class of the annotation

Returns:

the annotation on tree that has the class target, or null