org.checkerframework.framework.util.element

Class VariableApplier

java.lang.Object

org.checkerframework.framework.util.element.VariableApplier

public class VariableApplier
extends java.lang.Object

Applies annotations to variable declaration (providing they are not the use of a TYPE_PARAMETER).

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.lang.model.element.Element	element An Element that type represents.
protected AnnotatedTypeMirror	type The type to which we wish to apply annotations.

Method Summary

Modifier and Type	Method and Description
static boolean	accepts(AnnotatedTypeMirror typeMirror, javax.lang.model.element.Element element)
protected com.sun.tools.javac.code.TargetType[]	annotatedTargets()
static void	apply(AnnotatedTypeMirror type, javax.lang.model.element.Element element) Apply annotations from element to type.
void	extractAndApply() Reads the list of annotations that apply to this element (see getRawTypeAttributes).
protected java.lang.Iterable<com.sun.tools.javac.code.Attribute.TypeCompound>	getRawTypeAttributes() Annotations on elements are represented as Attribute.TypeCompounds ( a subtype of AnnotationMirror) that are usually accessed through a getRawTypeAttributes method on the element.
protected void	handleInvalid(java.util.List<com.sun.tools.javac.code.Attribute.TypeCompound> invalid)
protected void	handleTargeted(java.util.List<com.sun.tools.javac.code.Attribute.TypeCompound> targeted) This method should apply all annotations that are handled by this object.
protected void	handleValid(java.util.List<com.sun.tools.javac.code.Attribute.TypeCompound> valid) The default implementation of this method does nothing.
protected boolean	isAccepted() Tests element/type fields to ensure that this TargetedElementAnnotationApplier is valid for this element/type pair.
protected java.util.Map<org.checkerframework.framework.util.element.TargetedElementAnnotationApplier.TargetClass,java.util.List<com.sun.tools.javac.code.Attribute.TypeCompound>>	sift(java.lang.Iterable<com.sun.tools.javac.code.Attribute.TypeCompound> typeCompounds) Separate the input annotations into a Map of TargetClass (TARGETED, VALID, INVALID) to the annotations that fall into each of those categories.
protected com.sun.tools.javac.code.TargetType[]	validTargets()

Methods inherited from class java.lang.Object

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

Field Detail

type

protected final AnnotatedTypeMirror type

The type to which we wish to apply annotations.

element

protected final javax.lang.model.element.Element element

An Element that type represents.

Method Detail

apply

public static void apply(AnnotatedTypeMirror type,
                         javax.lang.model.element.Element element)
                  throws ElementAnnotationUtil.UnexpectedAnnotationLocationException

Apply annotations from element to type.

Throws:

ElementAnnotationUtil.UnexpectedAnnotationLocationException

accepts

public static boolean accepts(AnnotatedTypeMirror typeMirror,
                              javax.lang.model.element.Element element)

Returns:

true if this is a variable declaration including fields an enum constants

annotatedTargets

protected com.sun.tools.javac.code.TargetType[] annotatedTargets()

Returns:

the TargetTypes that identify annotations we wish to apply with this object. Any annotations that have these target types will be passed to handleTargeted.

validTargets

protected com.sun.tools.javac.code.TargetType[] validTargets()

Returns:

the TargetTypes that identify annotations that are valid but we wish to ignore. Any annotations that have these target types will be passed to handleValid, providing they aren't also in annotatedTargets.

getRawTypeAttributes

protected java.lang.Iterable<com.sun.tools.javac.code.Attribute.TypeCompound> getRawTypeAttributes()

Annotations on elements are represented as Attribute.TypeCompounds ( a subtype of AnnotationMirror) that are usually accessed through a getRawTypeAttributes method on the element.

In Java 8 and later these annotations are generally contained by elements to which they apply. However, in earlier versions of Java many of these annotations are handled by either the enclosing method, e.g. parameters and method type parameters, or enclosing class, e.g. class type parameters. Therefore, many annotations are addressed by first getting all annotations on a method or class and the picking out only the ones we wish to target (see extractAndApply).

Returns:

the annotations that we MAY wish to apply to the given type

isAccepted

protected boolean isAccepted()

Tests element/type fields to ensure that this TargetedElementAnnotationApplier is valid for this element/type pair.

Returns:

true if the type/element members are handled by this class false otherwise

handleTargeted

protected void handleTargeted(java.util.List<com.sun.tools.javac.code.Attribute.TypeCompound> targeted)
                       throws ElementAnnotationUtil.UnexpectedAnnotationLocationException

This method should apply all annotations that are handled by this object.

Parameters:

targeted - the list of annotations that were returned by getRawTypeAttributes and had a TargetType contained by annotatedTargets

Throws:

ElementAnnotationUtil.UnexpectedAnnotationLocationException

extractAndApply

public void extractAndApply()
                     throws ElementAnnotationUtil.UnexpectedAnnotationLocationException

Reads the list of annotations that apply to this element (see getRawTypeAttributes). Sifts them into three groups (TARGETED, INVALID, VALID) and then calls the appropriate handle method on them. The handleTargeted method should apply all annotations that are handled by this object.

This method will throw a runtime exception if isAccepted returns false.

Throws:

ElementAnnotationUtil.UnexpectedAnnotationLocationException

handleValid

protected void handleValid(java.util.List<com.sun.tools.javac.code.Attribute.TypeCompound> valid)

The default implementation of this method does nothing.

Parameters:

valid - the list of annotations that were returned by getRawTypeAttributes and had a TargetType contained by valid and NOT annotatedTargets

handleInvalid

protected void handleInvalid(java.util.List<com.sun.tools.javac.code.Attribute.TypeCompound> invalid)

Parameters:

invalid - the list of annotations that were returned by getRawTypeAttributes and were not handled by handleTargeted or handleValid

sift

protected java.util.Map<org.checkerframework.framework.util.element.TargetedElementAnnotationApplier.TargetClass,java.util.List<com.sun.tools.javac.code.Attribute.TypeCompound>> sift(java.lang.Iterable<com.sun.tools.javac.code.Attribute.TypeCompound> typeCompounds)

Separate the input annotations into a Map of TargetClass (TARGETED, VALID, INVALID) to the annotations that fall into each of those categories.

Parameters:

typeCompounds - annotations to sift through, should be those returned by getRawTypeAttributes

Returns:

a Map<TargetClass &rArr; Annotations>.