org.checkerframework.framework.type

Class AnnotatedTypeMirror.AnnotatedDeclaredType

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeMirror

org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType

Enclosing class:

AnnotatedTypeMirror

public static class AnnotatedTypeMirror.AnnotatedDeclaredType
extends AnnotatedTypeMirror

Represents a declared type (whether class or interface).

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 AnnotatedTypeMirror.AnnotatedDeclaredType	enclosingType The enclosing Type
protected List<AnnotatedTypeMirror>	typeArgs Parametrized Type Arguments

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

actualType, annotations, atypeFactory, equalityComparer, hashcodeVisitor

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.AnnotatedDeclaredType	asUse()
AnnotatedTypeMirror.AnnotatedDeclaredType	deepCopy()
AnnotatedTypeMirror.AnnotatedDeclaredType	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.
AnnotatedTypeMirror.AnnotatedDeclaredType	getEnclosingType() Returns the enclosing type, as in the type of A in the type A.B.
AnnotatedTypeMirror.AnnotatedDeclaredType	getErased() Return the declared type with its type arguments removed.
List<AnnotatedTypeMirror>	getTypeArguments()
DeclaredType	getUnderlyingType() Returns the underlying unannotated Java type, which this wraps
boolean	isDeclaration() Returns true if this type mirror represents a declaration, rather than a use, of a type.
void	setTypeArguments(List<? extends AnnotatedTypeMirror> ts) Sets the type arguments on this type
protected void	setWasRaw() Set the wasRaw flag to true.
AnnotatedTypeMirror.AnnotatedDeclaredType	shallowCopy() Returns a shallow copy of this type with annotations.
AnnotatedTypeMirror.AnnotatedDeclaredType	shallowCopy(boolean copyAnnotations) Returns a shallow copy of this type.
boolean	wasRaw() Returns true if the type was raw, that is, type arguments were not provided but instead inferred.

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

addAnnotation, addAnnotation, addAnnotations, addMissingAnnotations, clearAnnotations, createType, createTypeOfObject, equals, getAnnotation, getAnnotationInHierarchy, getAnnotations, getAnnotationsField, getEffectiveAnnotation, getEffectiveAnnotationInHierarchy, getEffectiveAnnotations, getExplicitAnnotations, getKind, hasAnnotation, hasAnnotation, hasAnnotationRelaxed, hasEffectiveAnnotation, hasEffectiveAnnotation, hasEffectiveAnnotationRelaxed, hasExplicitAnnotation, hasExplicitAnnotation, hasExplicitAnnotationRelaxed, hashCode, isAnnotatedInHierarchy, 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

typeArgs

protected List<AnnotatedTypeMirror> typeArgs

Parametrized Type Arguments

enclosingType

protected AnnotatedTypeMirror.AnnotatedDeclaredType enclosingType

The enclosing Type

Method Detail

isDeclaration

public boolean isDeclaration()

Description copied from class: AnnotatedTypeMirror

Returns true if this type mirror represents a declaration, rather than a use, of a type.

For example, class List<T> { ... } declares a new type List<T>, while List<Integer> is a use of the type.

Overrides:

isDeclaration in class AnnotatedTypeMirror

Returns:

true if this represents a declaration

deepCopy

public AnnotatedTypeMirror.AnnotatedDeclaredType 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.AnnotatedDeclaredType deepCopy()

Specified by:

deepCopy in class AnnotatedTypeMirror

Returns:

a deep copy of this type with annotations

See Also:

AnnotatedTypeMirror.deepCopy(boolean)

asUse

public AnnotatedTypeMirror.AnnotatedDeclaredType asUse()

Overrides:

asUse in class AnnotatedTypeMirror

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

setTypeArguments

public void setTypeArguments(List<? extends AnnotatedTypeMirror> ts)

Sets the type arguments on this type

Parameters:

ts - the type arguments

getTypeArguments

public List<AnnotatedTypeMirror> getTypeArguments()

Returns:

the type argument for this type

wasRaw

public boolean wasRaw()

Returns true if the type was raw, that is, type arguments were not provided but instead inferred.

Returns:

true iff the type was raw

setWasRaw

protected void setWasRaw()

Set the wasRaw flag to true. This should only be necessary when determining the supertypes of a raw type.

getUnderlyingType

public DeclaredType getUnderlyingType()

Description copied from class: AnnotatedTypeMirror

Returns the underlying unannotated Java type, which this wraps

Overrides:

getUnderlyingType in class AnnotatedTypeMirror

Returns:

the underlying type

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)

shallowCopy

public AnnotatedTypeMirror.AnnotatedDeclaredType shallowCopy()

Description copied from class: AnnotatedTypeMirror

Returns a shallow copy of this type with annotations.

Specified by:

shallowCopy in class AnnotatedTypeMirror

See Also:

AnnotatedTypeMirror.shallowCopy(boolean)

shallowCopy

public AnnotatedTypeMirror.AnnotatedDeclaredType 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 copie.

Specified by:

shallowCopy in class AnnotatedTypeMirror

Parameters:

copyAnnotations - whether copy should have annotations, i.e. whether field annotations should be copied.

getErased

public AnnotatedTypeMirror.AnnotatedDeclaredType getErased()

Return the declared type with its type arguments removed. This also replaces the underlying type with its erasure.

Overrides:

getErased in class AnnotatedTypeMirror

Returns:

a fresh copy of the declared type with no type arguments

See Also:

https://docs.oracle.com/javase/specs/jls/se8/html/jls-4.html#jls-4.6

getEnclosingType

public AnnotatedTypeMirror.AnnotatedDeclaredType getEnclosingType()

Returns the enclosing type, as in the type of A in the type A.B.

Returns:

enclosingType the enclosing type