org.checkerframework.javacutil

Class BasicAnnotationProvider

java.lang.Object

org.checkerframework.javacutil.BasicAnnotationProvider

All Implemented Interfaces:

AnnotationProvider

public class BasicAnnotationProvider
extends Object
implements AnnotationProvider

An AnnotationProvider that is independent of any type hierarchy.

Constructor Summary

Constructors

Constructor and Description
BasicAnnotationProvider()

Method Summary

Modifier and Type	Method and Description
@Nullable AnnotationMirror	getAnnotationMirror(Tree tree, Class<? extends Annotation> target) Return the annotation on tree that is in the hierarchy that contains the qualifier target.
@Nullable AnnotationMirror	getDeclAnnotation(Element elt, Class<? extends Annotation> anno) Returns the AnnotationMirror, of the given class, used to annotate the element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicAnnotationProvider

public BasicAnnotationProvider()

Method Detail

getDeclAnnotation

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

Returns the AnnotationMirror, of the given class, used to annotate the element. Returns null if no such annotation exists.

Specified by:

getDeclAnnotation in interface AnnotationProvider

Parameters:

elt - the element

anno - annotation class

Returns:

an annotation mirror of class anno on elt, or an equivalent one, or null if none exists on anno

getAnnotationMirror

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

Return the annotation on tree that is in the hierarchy that contains the qualifier target. Returns null if none exists.

This implementation always returns null, because it has no access to any type hierarchy.

Specified by:

getAnnotationMirror in interface AnnotationProvider

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