org.checkerframework.framework.util.element

Class MethodApplier

java.lang.Object

org.checkerframework.framework.util.element.MethodApplier

public class MethodApplier
extends java.lang.Object

Adds annotations from element to the return type, formal parameter types, type parameters, and throws clauses of the AnnotatedExecutableType type.

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, AnnotatedTypeFactory typeFactory)
void	extractAndApply() Sets the method's element, annotates its return type, parameters, type parameters, and throws annotations.
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,
                         AnnotatedTypeFactory typeFactory)

accepts

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

annotatedTargets

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

Returns:

receiver, returns, and throws. See extract and apply as we also annotate type params.

validTargets

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

Returns:

all possible annotation positions for a method except those 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 on the method symbol (element)

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

extractAndApply

public void extractAndApply()

Sets the method's element, annotates its return type, parameters, type parameters, and throws annotations.

handleTargeted

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.

Parameters:

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

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>.