Class SuperTypeApplier


  • public class SuperTypeApplier
    extends java.lang.Object
    When discovering supertypes of an AnnotatedTypeMirror we want to annotate each supertype with the annotations of the subtypes class declaration. This class provides static methods to do this for a list of supertypes. An instance of this class handles ONE supertype.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected javax.lang.model.element.Element element
      An Element that type represents.
      protected AnnotatedTypeMirror type
      The type to which we wish to apply annotations.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected com.sun.tools.javac.code.TargetType[] annotatedTargets()
      Returns TargetType.CLASS_EXTENDS.
      static void annotateSupers​(java.util.List<AnnotatedTypeMirror.AnnotatedDeclaredType> supertypes, javax.lang.model.element.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 java.lang.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​(java.util.List<com.sun.tools.javac.code.Attribute.TypeCompound> invalid)
      This implementation reports all invalid annotations as errors.
      protected void handleTargeted​(java.util.List<com.sun.tools.javac.code.Attribute.TypeCompound> targeted)
      This method should apply all annotations that are handled by this object.
      protected void handleValid​(java.util.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 java.util.Map<org.checkerframework.framework.util.element.TargetedElementAnnotationApplier.TargetClass,​java.util.List<com.sun.tools.javac.code.Attribute.TypeCompound>> sift​(java.lang.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.
      • 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 javax.lang.model.element.Element element
        An Element that type represents.
    • Method Detail

      • getElementIndex

        public int getElementIndex()
        Returns the type_index that should represent supertype.
        Returns:
        the type_index that should represent supertype
      • getTypeCompoundIndex

        public int getTypeCompoundIndex​(com.sun.tools.javac.code.Attribute.TypeCompound anno)
        Returns the type_index of anno's TypeAnnotationPosition.
        Parameters:
        anno - an annotation we might wish to apply
        Returns:
        the type_index of anno's TypeAnnotationPosition
      • annotatedTargets

        protected com.sun.tools.javac.code.TargetType[] annotatedTargets()
        Returns TargetType.CLASS_EXTENDS.
        Returns:
        TargetType.CLASS_EXTENDS
      • validTargets

        protected com.sun.tools.javac.code.TargetType[] validTargets()
        Returns TargetType.CLASS_TYPE_PARAMETER, TargetType.CLASS_TYPE_PARAMETER_BOUND.
        Returns:
        TargetType.CLASS_TYPE_PARAMETER, TargetType.CLASS_TYPE_PARAMETER_BOUND
      • getRawTypeAttributes

        protected java.lang.Iterable<com.sun.tools.javac.code.Attribute.TypeCompound> getRawTypeAttributes()
        Returns the TypeCompounds (annotations) of the subclass.
        Returns:
        the TypeCompounds (annotations) of the subclass
      • 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
      • sift

        protected java.util.Map<org.checkerframework.framework.util.element.TargetedElementAnnotationApplier.TargetClass,​java.util.List<com.sun.tools.javac.code.Attribute.TypeCompound>> sift​(java.lang.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​(java.util.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​(java.util.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