org.checkerframework.framework.type

Class AnnotatedTypeMirror.AnnotatedIntersectionType

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeMirror

org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedIntersectionType

Enclosing class:

AnnotatedTypeMirror

public static class AnnotatedTypeMirror.AnnotatedIntersectionType
extends AnnotatedTypeMirror

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.framework.type.AnnotatedTypeMirror

AnnotatedTypeMirror.AnnotatedArrayType, AnnotatedTypeMirror.AnnotatedDeclaredType, AnnotatedTypeMirror.AnnotatedExecutableType, AnnotatedTypeMirror.AnnotatedIntersectionType, AnnotatedTypeMirror.AnnotatedNoType, AnnotatedTypeMirror.AnnotatedNullType, AnnotatedTypeMirror.AnnotatedPrimitiveType, AnnotatedTypeMirror.AnnotatedTypeVariable, AnnotatedTypeMirror.AnnotatedUnionType, AnnotatedTypeMirror.AnnotatedWildcardType

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AnnotatedTypeMirror.AnnotatedDeclaredType>	supertypes

Fields inherited from class org.checkerframework.framework.type.AnnotatedTypeMirror

actualType, annotations, atypeFactory, EQUALITY_COMPARER, HASHCODE_VISITOR

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(AnnotatedTypeVisitor<R,P> v, P p) Applies a visitor to this type.
AnnotatedTypeMirror.AnnotatedIntersectionType	deepCopy() Returns a deep copy of this type with annotations.
AnnotatedTypeMirror.AnnotatedIntersectionType	deepCopy(boolean copyAnnotations) Returns a deep copy of this type.
List<AnnotatedTypeMirror.AnnotatedDeclaredType>	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.
List<AnnotatedTypeMirror.AnnotatedDeclaredType>	directSuperTypesField()
AnnotatedTypeMirror.AnnotatedIntersectionType	shallowCopy() Returns a shallow copy of this type with annotations.
AnnotatedTypeMirror.AnnotatedIntersectionType	shallowCopy(boolean copyAnnotations) Returns a shallow copy of this type.

Methods inherited from class org.checkerframework.framework.type.AnnotatedTypeMirror

addAnnotation, addAnnotation, addAnnotations, addMissingAnnotations, asUse, clearAnnotations, createType, createTypeOfObject, equals, getAnnotation, getAnnotationInHierarchy, getAnnotations, getAnnotationsField, getEffectiveAnnotation, getEffectiveAnnotationInHierarchy, getEffectiveAnnotations, getErased, getExplicitAnnotations, getKind, getUnderlyingType, hasAnnotation, hasAnnotation, hasAnnotationRelaxed, hasEffectiveAnnotation, hasEffectiveAnnotation, hasEffectiveAnnotationRelaxed, hasExplicitAnnotation, hasExplicitAnnotation, hasExplicitAnnotationRelaxed, hashCode, isAnnotatedInHierarchy, isDeclaration, removeAnnotation, removeAnnotation, removeAnnotationInHierarchy, removeAnnotations, removeNonTopAnnotationInHierarchy, replaceAnnotation, replaceAnnotations, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

supertypes

protected List<AnnotatedTypeMirror.AnnotatedDeclaredType> supertypes

Method Detail

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

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 class AnnotatedTypeMirror

Returns:

a deep copy of this type with annotations

See Also:

AnnotatedTypeMirror.deepCopy(boolean)

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

See Also:

AnnotatedTypeMirror.shallowCopy(boolean)

directSuperTypes

public List<AnnotatedTypeMirror.AnnotatedDeclaredType> directSuperTypes()

Description copied from class: AnnotatedTypeMirror

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

Overrides:

directSuperTypes in class AnnotatedTypeMirror

See Also:

Types.directSupertypes(TypeMirror)

directSuperTypesField

public List<AnnotatedTypeMirror.AnnotatedDeclaredType> directSuperTypesField()