Package org.checkerframework.framework.type

Class AnnotatedTypeMirror.AnnotatedIntersectionType

java.lang.Object
org.checkerframework.framework.type.AnnotatedTypeMirror
org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedIntersectionType
All Implemented Interfaces:
org.plumelib.util.DeepCopyable<AnnotatedTypeMirror>
Enclosing class:
AnnotatedTypeMirror
public static class AnnotatedTypeMirror.AnnotatedIntersectionType extends AnnotatedTypeMirror
Represents an intersection type.

For example: MyObject & Serializable & Comparable<MyObject>

  • Field Details

  • Method Details

    • addAnnotation

      public void addAnnotation(AnnotationMirror annotation)
      Adds the canonical version of annotation as a primary annotation of this type and, in the case of AnnotatedTypeMirror.AnnotatedTypeVariables, AnnotatedTypeMirror.AnnotatedWildcardTypes, and AnnotatedTypeMirror.AnnotatedIntersectionTypes, adds it to all bounds. (The canonical version is found via AnnotatedTypeFactory.canonicalAnnotation(javax.lang.model.element.AnnotationMirror).) If the canonical version of annotation is not a supported qualifier, then no annotation is added. If this type already has annotation in the same hierarchy as annotation, the behavior of this method is undefined.

      Also, copies a to all the bounds.

      Overrides:
      addAnnotation in class AnnotatedTypeMirror
      Parameters:
      annotation - the annotation to add

    • accept

      public <R, P> R accept(AnnotatedTypeVisitor<R,P> v, P p)
      Description copied from class: AnnotatedTypeMirror
      Applies a visitor to this type.
      Specified by:
      accept in class AnnotatedTypeMirror
      Type Parameters:
      R - the return type of the visitor's methods
      P - the type of the additional parameter to the visitor's methods
      Parameters:
      v - the visitor operating on this type
      p - additional parameter to the visitor
      Returns:
      a visitor-specified result

    • getUnderlyingType

      public IntersectionType getUnderlyingType()
      Description copied from class: AnnotatedTypeMirror
      Returns the underlying unannotated Java type, which this wraps.
      Overrides:
      getUnderlyingType in class AnnotatedTypeMirror
      Returns:
      the underlying type

    • deepCopy

      public AnnotatedTypeMirror.AnnotatedIntersectionType deepCopy(boolean copyAnnotations)
      Description copied from class: AnnotatedTypeMirror
      Returns a deep copy of this type. A deep copy implies that each component type is copied recursively and the returned type refers to those copies in its component locations.

      Note: deepCopy provides two important properties in the returned copy:

      1. Structure preservation -- The exact structure of the original AnnotatedTypeMirror is preserved in the copy including all component types.
      2. Annotation preservation -- All of the annotations from the original AnnotatedTypeMirror and its components have been copied to the new type.
      If copyAnnotations is set to false, the second property, Annotation preservation, is removed. This is useful for cases in which the user may want to copy the structure of a type exactly but NOT its annotations.
      Specified by:
      deepCopy in class AnnotatedTypeMirror
      Returns:
      a deep copy

    • deepCopy

      public AnnotatedTypeMirror.AnnotatedIntersectionType deepCopy()
      Description copied from class: AnnotatedTypeMirror
      Returns a deep copy of this type with annotations.

      Each subclass implements this method with the subclass return type. The method body must always be a call to deepCopy(true).

      Specified by:
      deepCopy in interface org.plumelib.util.DeepCopyable<AnnotatedTypeMirror>
      Specified by:
      deepCopy in class AnnotatedTypeMirror
      Returns:
      a deep copy of this type with annotations
      See Also:

    • shallowCopy

      public AnnotatedTypeMirror.AnnotatedIntersectionType shallowCopy(boolean copyAnnotations)
      Description copied from class: AnnotatedTypeMirror
      Returns a shallow copy of this type. A shallow copy implies that each component type in the output copy refers to the same object as the object being copied.
      Specified by:
      shallowCopy in class AnnotatedTypeMirror
      Parameters:
      copyAnnotations - whether copy should have annotations, i.e. whether field annotations should be copied.

    • shallowCopy

      public AnnotatedTypeMirror.AnnotatedIntersectionType shallowCopy()
      Description copied from class: AnnotatedTypeMirror
      Returns a shallow copy of this type with annotations.

      Each subclass implements this method with the subclass return type. The method body must always be a call to shallowCopy(true).

      Specified by:
      shallowCopy in class AnnotatedTypeMirror
      Returns:
      a shallow copy of this type with annotations
      See Also:

    • directSupertypes

      public List<? extends AnnotatedTypeMirror> directSupertypes()
      This method returns a list of AnnotatedTypeMirrors where the Java type of each ATM is an immediate supertype (class or interface) of the Java type of this. The interface types, if any, appear at the end of the list. If the directSuperType has type arguments, then the annotations on those type arguments are taken with proper translation from the declaration of the Java type of this.

      For example, 

       class B<T> { ... } 
 class A extends B<@NonNull String> { ... } 
 @Nullable A a;
      The direct supertype of the ATM @Nullable A is @Nullable B<@NonNull String>.

      An example with more complex type arguments: 

       class D<Q,R> { ... } 
 class A<T,S> extends D<S,T> { ... } 
 @Nullable A<@NonNull String, @NonNull Object> a;
      The direct supertype of the ATM @Nullable A<@NonNull String, @NonNull Object> is @Nullable B<@NonNull Object, @NonNull String>.

      An example with more than one direct supertype: 

       class B<T> implements List<Integer> { ... } 
 class A extends B<@NonNull String> implements List<Integer> { ... } 
 @Nullable A a;
      The direct supertypes of the ATM @Nullable A are @Nullable B <@NonNull String> and @Nullable List<@NonNull Integer>.

      This returns the same types as getBounds().

      Overrides:
      directSupertypes in class AnnotatedTypeMirror
      Returns:
      the direct super types of this
      See Also:

    • getBounds

      public List<AnnotatedTypeMirror> getBounds()
      This returns the bounds of the intersection type. Although only declared types can appear in an explicitly written intersections, during capture conversion, intersections with other kinds of types are created.

      This returns the same types as directSupertypes().

      Returns:
      the bounds of this, which are also the direct super types of this

    • setBounds

      public void setBounds(List<AnnotatedTypeMirror> bounds)
      Sets the bounds.
      Parameters:
      bounds - a list of bounds to be captured by this method

    • copyIntersectionBoundAnnotations

      public void copyIntersectionBoundAnnotations()
      Copy the first annotation (in each hierarchy) on a bound to the primary annotation location of the intersection type.

      For example, in the type @NonNull Object & @Initialized @Nullable Serializable, @Nullable and @Initialized are copied to the primary annotation location.