org.checkerframework.framework.util.element

Class ParamApplier

java.lang.Object

org.checkerframework.framework.util.element.ParamApplier

public class ParamApplier
extends Object

Adds annotations to one formal parameter of a method or lambda within a method.

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	element An Element that type represents.
static int	RECEIVER_PARAM_INDEX
protected AnnotatedTypeMirror	type The type to which we wish to apply annotations.

Method Summary

Modifier and Type	Method and Description
static boolean	accepts(AnnotatedTypeMirror type, Element element)
protected com.sun.tools.javac.code.TargetType[]	annotatedTargets()
static void	apply(AnnotatedTypeMirror type, Element element, AnnotatedTypeFactory typeFactory) Apply annotations from element to type.
void	extractAndApply() Reads the list of annotations that apply to this element (see getRawTypeAttributes).
int	getElementIndex() The index of element in the list of elements that contains it.
static com.sun.tools.javac.code.Symbol.MethodSymbol	getParentMethod(Element methodChildElem) Return the enclosing MethodSymbol of the given element, throwing an exception of the symbol's enclosing element is not a MethodSymbol.
protected 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.
int	getTypeCompoundIndex(com.sun.tools.javac.code.Attribute.TypeCompound anno) A TypeAnnotationPosition has a number of different indexes (type_index, bound_index, param_index) Return the index we are interested in.
protected void	handleInvalid(List<com.sun.tools.javac.code.Attribute.TypeCompound> invalid)
protected void	handleTargeted(List<com.sun.tools.javac.code.Attribute.TypeCompound> targeted) This method should apply all annotations that are handled by this object.
protected void	handleValid(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 Map<org.checkerframework.framework.util.element.TargetedElementAnnotationApplier.TargetClass,List<com.sun.tools.javac.code.Attribute.TypeCompound>>	sift(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

RECEIVER_PARAM_INDEX

public static final int RECEIVER_PARAM_INDEX

See Also:

Constant Field Values

type

protected final AnnotatedTypeMirror type

The type to which we wish to apply annotations.

element

protected final Element element

An Element that type represents.

Method Detail

apply

public static void apply(AnnotatedTypeMirror type,
                         Element element,
                         AnnotatedTypeFactory typeFactory)
                  throws ElementAnnotationUtil.UnexpectedAnnotationLocationException

Apply annotations from element to type.

Throws:

ElementAnnotationUtil.UnexpectedAnnotationLocationException

accepts

public static boolean accepts(AnnotatedTypeMirror type,
                              Element element)

getElementIndex

public int getElementIndex()

The index of element in the list of elements that contains it.

Returns:

the index of element its parent method's parameter list. Integer.MIN_VALUE if the element is the receiver parameter.

getTypeCompoundIndex

public int getTypeCompoundIndex(com.sun.tools.javac.code.Attribute.TypeCompound anno)

A TypeAnnotationPosition has a number of different indexes (type_index, bound_index, param_index) Return the index we are interested in. If offsetting needs to be done it should be done in getElementIndex not here. (see ElementAnnotationUtils.getBoundIndexOffset )

Parameters:

anno - an annotation we might wish to apply

Returns:

the parameter index of anno's TypeAnnotationPosition

annotatedTargets

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

Returns:

{TargetType.METHOD_FORMAL_PARAMETER, TargetType.METHOD_RECEIVER}

validTargets

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

Returns:

any annotation TargetType that can be found on a method

getRawTypeAttributes

protected 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 TypeCompounds (annotations) of the enclosing method for this parameter

sift

protected Map<org.checkerframework.framework.util.element.TargetedElementAnnotationApplier.TargetClass,List<com.sun.tools.javac.code.Attribute.TypeCompound>> sift(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>.

handleTargeted

protected void handleTargeted(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 - type compounds with formal method parameter target types with parameter_index == getIndex

Throws:

ElementAnnotationUtil.UnexpectedAnnotationLocationException

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

getParentMethod

public static com.sun.tools.javac.code.Symbol.MethodSymbol getParentMethod(Element methodChildElem)

Return the enclosing MethodSymbol of the given element, throwing an exception of the symbol's enclosing element is not a MethodSymbol.

Parameters:

methodChildElem - some element that is a child of a method typeDeclaration (e.g. a parameter or return type)

Returns:

the MethodSymbol of the method containing methodChildElem

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