Package org.checkerframework.framework.util.element

Class ClassTypeParamApplier

java.lang.Object
org.checkerframework.framework.util.element.ClassTypeParamApplier
public class ClassTypeParamApplier extends Object
Applies the annotations present for a class type parameter onto an AnnotatedTypeVariable. See TypeParamElementAnnotationApplier for details.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final Element
    element
    An Element that type represents.
    protected final AnnotatedTypeMirror
    type
    The type to which we wish to apply annotations.
    protected final AnnotatedTypeFactory
    typeFactory
     
    protected final AnnotatedTypeMirror.AnnotatedTypeVariable
    typeParam
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    accepts(AnnotatedTypeMirror type, Element element)
    Returns true if element represents a type parameter for a class.
    protected com.sun.tools.javac.code.TargetType[]
    annotatedTargets()
    Returns the lower bound and upper bound targets.
    static void
    apply(AnnotatedTypeMirror.AnnotatedTypeVariable 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()
    Returns the index of element in the type parameter list of its enclosing class.
    protected Iterable<com.sun.tools.javac.code.Attribute.TypeCompound>
    getRawTypeAttributes()
    Returns the raw type attributes of the enclosing class.
    int
    getTypeCompoundIndex(com.sun.tools.javac.code.Attribute.TypeCompound anno)
    Returns the parameter_index of anno's TypeAnnotationPosition which will actually point to the type parameter's index in its enclosing type parameter list.
    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 com.sun.tools.javac.code.TargetType
    lowerBoundTarget()
    Returns TargetType.CLASS_TYPE_PARAMETER.
    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
    upperBoundTarget()
    Returns TargetType.CLASS_TYPE_PARAMETER_BOUND.
    protected com.sun.tools.javac.code.TargetType[]
    validTargets()
    Returns the TargetTypes that identify annotations that are valid but we wish to ignore.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Method Details

    • apply

      public static void apply(AnnotatedTypeMirror.AnnotatedTypeVariable 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)
      Returns true if element represents a type parameter for a class.
      Parameters:
      type - ignored
      element - the element that might be a type parameter
      Returns:
      true if element represents a type parameter for a class

    • lowerBoundTarget

      protected com.sun.tools.javac.code.TargetType lowerBoundTarget()
      Returns TargetType.CLASS_TYPE_PARAMETER.
      Returns:
      TargetType.CLASS_TYPE_PARAMETER

    • upperBoundTarget

      protected com.sun.tools.javac.code.TargetType upperBoundTarget()
      Returns TargetType.CLASS_TYPE_PARAMETER_BOUND.
      Returns:
      TargetType.CLASS_TYPE_PARAMETER_BOUND

    • getElementIndex

      public int getElementIndex()
      Returns the index of element in the type parameter list of its enclosing class.
      Returns:
      the index of element in the type parameter list of its enclosing class

    • 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.
      Returns:
      the TargetTypes that identify annotations that are valid but we wish to ignore

    • getRawTypeAttributes

      protected Iterable<com.sun.tools.javac.code.Attribute.TypeCompound> getRawTypeAttributes()
      Returns the raw type attributes of the enclosing class.
      Returns:
      the raw type attributes of the enclosing class

    • 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

    • annotatedTargets

      protected com.sun.tools.javac.code.TargetType[] annotatedTargets()
      Returns the lower bound and upper bound targets.
      Returns:
      the lower bound and upper bound targets

    • getTypeCompoundIndex

      public int getTypeCompoundIndex(com.sun.tools.javac.code.Attribute.TypeCompound anno)
      Returns the parameter_index of anno's TypeAnnotationPosition which will actually point to the type parameter's index in its enclosing type parameter list.
      Parameters:
      anno - an annotation we might wish to apply
      Returns:
      the parameter_index of anno's TypeAnnotationPosition which will actually point to the type parameter's index in its enclosing type parameter list

    • 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 on the lower/upper bounds of the type parameter

      Note: When handling type parameters we NEVER add primary annotations to the type parameter. Primary annotations are reserved for the use of a type parameter (e.g. @Nullable T t; )

      If an annotation is present on the type parameter itself, it represents the lower-bound annotation of that type parameter. Any annotation on the extends bound of a type parameter is placed on that bound.

      Throws:
      ElementAnnotationUtil.UnexpectedAnnotationLocationException

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

    • 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

    • 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