org.checkerframework.framework.util.element

Class TypeDeclarationApplier

java.lang.Object

org.checkerframework.framework.util.element.TypeDeclarationApplier

public class TypeDeclarationApplier
extends Object

Apply annotations to a declared type based on its declaration.

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	element An Element that type represents.
static int	SUPERCLASS_INDEX If a type_index == -1 it means that the index refers to the immediate supertype class of the declaration.
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)
void	extractAndApply() Adds extends/implements and class annotations to type.
protected Iterable<com.sun.tools.javac.code.Attribute.TypeCompound>	getRawTypeAttributes() All TypeCompounds (annotations) on the ClassSymbol.
protected void	handleInvalid(List<com.sun.tools.javac.code.Attribute.TypeCompound> invalid)
protected void	handleTargeted(List<com.sun.tools.javac.code.Attribute.TypeCompound> extendsAndImplementsAnnos) While more than just annotations on extends or implements clause are annotated by this class, only these annotations are passed to handleTargeted (as they are the only in the annotatedTargets list).
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

SUPERCLASS_INDEX

public static final int SUPERCLASS_INDEX

If a type_index == -1 it means that the index refers to the immediate supertype class of the declaration. There is only ever one of these since java has no multiple inheritance

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)

accepts

public static boolean accepts(AnnotatedTypeMirror type,
                              Element element)

Returns:

true if type is an annotated declared type and element is a ClassSymbol

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.

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.

getRawTypeAttributes

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

All TypeCompounds (annotations) on the ClassSymbol.

Returns:

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

handleTargeted

protected void handleTargeted(List<com.sun.tools.javac.code.Attribute.TypeCompound> extendsAndImplementsAnnos)

While more than just annotations on extends or implements clause are annotated by this class, only these annotations are passed to handleTargeted (as they are the only in the annotatedTargets list). See extractAndApply for type parameters

Parameters:

extendsAndImplementsAnnos - annotations with a TargetType of CLASS_EXTENDS

extractAndApply

public void extractAndApply()

Adds extends/implements and class annotations to type. Annotates type parameters.

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

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

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