org.checkerframework.framework.util.element

Class MethodApplier

java.lang.Object

org.checkerframework.framework.util.element.MethodApplier

public class MethodApplier
extends 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 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, Element element)
protected com.sun.tools.javac.code.TargetType[]	annotatedTargets() Returns receiver, returns, and throws.
static void	apply(AnnotatedTypeMirror type, Element element, AnnotatedTypeFactory typeFactory) Apply annotations from element to type.
void	extractAndApply() Sets the method's element, annotates its return type, parameters, type parameters, and throws annotations.
protected Iterable<com.sun.tools.javac.code.Attribute.TypeCompound>	getRawTypeAttributes() Returns the annotations on the method symbol (element).
protected void	handleInvalid(List<com.sun.tools.javac.code.Attribute.TypeCompound> invalid) This implementation reports all invalid annotations as errors.
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() Returns all possible annotation positions for a method except those in annotatedTargets.

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

Returns:

receiver, returns, and throws

validTargets

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

Returns all possible annotation positions for a method except those in annotatedTargets.

Returns:

all possible annotation positions for a method except those in annotatedTargets

getRawTypeAttributes

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

Returns the annotations on the method symbol (element).

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()
                     throws ElementAnnotationUtil.UnexpectedAnnotationLocationException

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

Throws:

ElementAnnotationUtil.UnexpectedAnnotationLocationException

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 - the list of annotations that were returned by getRawTypeAttributes and had a TargetType contained by annotatedTargets

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)

This implementation reports all invalid annotations as errors.

Parameters:

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

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