org.checkerframework.javacutil

Class TypeAnnotationUtils

java.lang.Object

org.checkerframework.javacutil.TypeAnnotationUtils

public class TypeAnnotationUtils
extends Object

A collection of helper methods related to type annotation handling.

See Also:

AnnotationUtils

Method Summary

Modifier and Type	Method and Description
static com.sun.tools.javac.code.Attribute	attributeFromAnnotationValue(ProcessingEnvironment env, ExecutableElement meth, AnnotationValue av) Returns a newly created Attribute corresponding to an argument AnnotationValue.
static com.sun.tools.javac.code.TypeAnnotationPosition	classExtendsTAPosition(int implidx, int pos)
static com.sun.tools.javac.code.TypeAnnotationPosition	copyTAPosition(com.sun.tools.javac.code.TypeAnnotationPosition tapos)
static com.sun.tools.javac.code.Attribute.Compound	createCompoundFromAnnotationMirror(ProcessingEnvironment env, AnnotationMirror am) Returns a newly created Attribute.Compound corresponding to an argument AnnotationMirror.
static com.sun.tools.javac.code.Attribute.TypeCompound	createTypeCompoundFromAnnotationMirror(ProcessingEnvironment env, AnnotationMirror am, com.sun.tools.javac.code.TypeAnnotationPosition tapos) Returns a newly created Attribute.TypeCompound corresponding to an argument AnnotationMirror.
static com.sun.tools.javac.code.TypeAnnotationPosition	fieldTAPosition(int pos)
static boolean	isSameTAPosition(com.sun.tools.javac.code.TypeAnnotationPosition p1, com.sun.tools.javac.code.TypeAnnotationPosition p2) Compare two TypeAnnotationPositions for equality.
static boolean	isSameTAPositionExceptTreePos(com.sun.tools.javac.code.TypeAnnotationPosition p1, com.sun.tools.javac.code.TypeAnnotationPosition p2)
static boolean	isTypeCompoundContained(Types types, com.sun.tools.javac.util.List<com.sun.tools.javac.code.Attribute.TypeCompound> list, com.sun.tools.javac.code.Attribute.TypeCompound tc) Check whether a TypeCompound is contained in a list of TypeCompounds.
static com.sun.tools.javac.code.TypeAnnotationPosition	methodParameterTAPosition(int pidx, int pos)
static com.sun.tools.javac.code.TypeAnnotationPosition	methodReceiverTAPosition(int pos)
static com.sun.tools.javac.code.TypeAnnotationPosition	methodReturnTAPosition(int pos)
static com.sun.tools.javac.code.TypeAnnotationPosition	methodThrowsTAPosition(int tidx, int pos)
static com.sun.tools.javac.code.TypeAnnotationPosition	methodTypeParameterBoundTAPosition(int tpidx, int bndidx, int pos)
static com.sun.tools.javac.code.TypeAnnotationPosition	methodTypeParameterTAPosition(int tpidx, int pos)
static com.sun.tools.javac.code.TypeAnnotationPosition	typeParameterBoundTAPosition(int tpidx, int bndidx, int pos)
static com.sun.tools.javac.code.TypeAnnotationPosition	typeParameterTAPosition(int tpidx, int pos)
static com.sun.tools.javac.code.Type	unannotatedType(TypeMirror in)
static com.sun.tools.javac.code.TypeAnnotationPosition	unknownTAPosition()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isTypeCompoundContained

public static boolean isTypeCompoundContained(Types types,
                                              com.sun.tools.javac.util.List<com.sun.tools.javac.code.Attribute.TypeCompound> list,
                                              com.sun.tools.javac.code.Attribute.TypeCompound tc)

Check whether a TypeCompound is contained in a list of TypeCompounds.

Parameters:

list - the input list of TypeCompounds

tc - the TypeCompound to find

Returns:

true, iff a TypeCompound equal to tc is contained in list

isSameTAPosition

public static boolean isSameTAPosition(com.sun.tools.javac.code.TypeAnnotationPosition p1,
                                       com.sun.tools.javac.code.TypeAnnotationPosition p2)

Compare two TypeAnnotationPositions for equality.

Parameters:

p1 - the first position

p2 - the second position

Returns:

true, iff the two positions are equal

isSameTAPositionExceptTreePos

public static boolean isSameTAPositionExceptTreePos(com.sun.tools.javac.code.TypeAnnotationPosition p1,
                                                    com.sun.tools.javac.code.TypeAnnotationPosition p2)

createCompoundFromAnnotationMirror

public static com.sun.tools.javac.code.Attribute.Compound createCompoundFromAnnotationMirror(ProcessingEnvironment env,
                                                                                             AnnotationMirror am)

Returns a newly created Attribute.Compound corresponding to an argument AnnotationMirror.

Parameters:

am - an AnnotationMirror, which may be part of an AST or an internally created subclass

Returns:

a new Attribute.Compound corresponding to the AnnotationMirror

createTypeCompoundFromAnnotationMirror

public static com.sun.tools.javac.code.Attribute.TypeCompound createTypeCompoundFromAnnotationMirror(ProcessingEnvironment env,
                                                                                                     AnnotationMirror am,
                                                                                                     com.sun.tools.javac.code.TypeAnnotationPosition tapos)

Returns a newly created Attribute.TypeCompound corresponding to an argument AnnotationMirror.

Parameters:

am - an AnnotationMirror, which may be part of an AST or an internally created subclass

tapos - the type annotation position to use

Returns:

a new Attribute.TypeCompound corresponding to the AnnotationMirror

attributeFromAnnotationValue

public static com.sun.tools.javac.code.Attribute attributeFromAnnotationValue(ProcessingEnvironment env,
                                                                              ExecutableElement meth,
                                                                              AnnotationValue av)

Returns a newly created Attribute corresponding to an argument AnnotationValue.

Parameters:

meth - the ExecutableElement that is assigned the value, needed for empty arrays

av - an AnnotationValue, which may be part of an AST or an internally created subclass

Returns:

a new Attribute corresponding to the AnnotationValue

unknownTAPosition

public static com.sun.tools.javac.code.TypeAnnotationPosition unknownTAPosition()

methodReturnTAPosition

public static com.sun.tools.javac.code.TypeAnnotationPosition methodReturnTAPosition(int pos)

methodReceiverTAPosition

public static com.sun.tools.javac.code.TypeAnnotationPosition methodReceiverTAPosition(int pos)

methodParameterTAPosition

public static com.sun.tools.javac.code.TypeAnnotationPosition methodParameterTAPosition(int pidx,
                                                                                        int pos)

methodThrowsTAPosition

public static com.sun.tools.javac.code.TypeAnnotationPosition methodThrowsTAPosition(int tidx,
                                                                                     int pos)

fieldTAPosition

public static com.sun.tools.javac.code.TypeAnnotationPosition fieldTAPosition(int pos)

classExtendsTAPosition

public static com.sun.tools.javac.code.TypeAnnotationPosition classExtendsTAPosition(int implidx,
                                                                                     int pos)

typeParameterTAPosition

public static com.sun.tools.javac.code.TypeAnnotationPosition typeParameterTAPosition(int tpidx,
                                                                                      int pos)

methodTypeParameterTAPosition

public static com.sun.tools.javac.code.TypeAnnotationPosition methodTypeParameterTAPosition(int tpidx,
                                                                                            int pos)

typeParameterBoundTAPosition

public static com.sun.tools.javac.code.TypeAnnotationPosition typeParameterBoundTAPosition(int tpidx,
                                                                                           int bndidx,
                                                                                           int pos)

methodTypeParameterBoundTAPosition

public static com.sun.tools.javac.code.TypeAnnotationPosition methodTypeParameterBoundTAPosition(int tpidx,
                                                                                                 int bndidx,
                                                                                                 int pos)

copyTAPosition

public static com.sun.tools.javac.code.TypeAnnotationPosition copyTAPosition(com.sun.tools.javac.code.TypeAnnotationPosition tapos)

unannotatedType

public static com.sun.tools.javac.code.Type unannotatedType(TypeMirror in)