public class SuperTypeApplier extends Object
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.
|
Modifier and Type | Method and Description |
---|---|
protected com.sun.tools.javac.code.TargetType[] |
annotatedTargets()
Returns TargetType.CLASS_EXTENDS.
|
static void |
annotateSupers(List<AnnotatedTypeMirror.AnnotatedDeclaredType> supertypes,
TypeElement subtypeElement)
Annotates each supertype with annotations from subtypeElement's extends/implements clauses.
|
void |
extractAndApply()
Reads the list of annotations that apply to this element (see getRawTypeAttributes).
|
int |
getElementIndex()
Returns the type_index that should represent supertype.
|
protected Iterable<com.sun.tools.javac.code.Attribute.TypeCompound> |
getRawTypeAttributes()
Returns the TypeCompounds (annotations) of the subclass.
|
int |
getTypeCompoundIndex(com.sun.tools.javac.code.Attribute.TypeCompound anno)
Returns the type_index of anno's TypeAnnotationPosition.
|
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 TargetType.CLASS_TYPE_PARAMETER, TargetType.CLASS_TYPE_PARAMETER_BOUND.
|
protected final AnnotatedTypeMirror type
protected final Element element
public static void annotateSupers(List<AnnotatedTypeMirror.AnnotatedDeclaredType> supertypes, TypeElement subtypeElement) throws ElementAnnotationUtil.UnexpectedAnnotationLocationException
supertypes
- supertypes to annotatesubtypeElement
- element that may have annotations to apply to supertypesElementAnnotationUtil.UnexpectedAnnotationLocationException
public int getElementIndex()
public int getTypeCompoundIndex(com.sun.tools.javac.code.Attribute.TypeCompound anno)
anno
- an annotation we might wish to applyprotected com.sun.tools.javac.code.TargetType[] annotatedTargets()
protected com.sun.tools.javac.code.TargetType[] validTargets()
protected Iterable<com.sun.tools.javac.code.Attribute.TypeCompound> getRawTypeAttributes()
protected void handleTargeted(List<com.sun.tools.javac.code.Attribute.TypeCompound> targeted) throws ElementAnnotationUtil.UnexpectedAnnotationLocationException
targeted
- the list of annotations that were returned by getRawTypeAttributes and had a
TargetType contained by annotatedTargetsElementAnnotationUtil.UnexpectedAnnotationLocationException
protected boolean isAccepted()
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)
typeCompounds
- annotations to sift through, should be those returned by
getRawTypeAttributesprotected void handleValid(List<com.sun.tools.javac.code.Attribute.TypeCompound> valid)
valid
- the list of annotations that were returned by getRawTypeAttributes and had a
TargetType contained by valid and NOT annotatedTargetsprotected void handleInvalid(List<com.sun.tools.javac.code.Attribute.TypeCompound> invalid)
invalid
- the list of annotations that were returned by getRawTypeAttributes and were
not handled by handleTargeted or handleValidpublic void extractAndApply() throws ElementAnnotationUtil.UnexpectedAnnotationLocationException
This method will throw a runtime exception if isAccepted returns false.