org.checkerframework.framework.type

Class AnnotatedTypeMirror.AnnotatedArrayType

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeMirror

org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedArrayType

Enclosing class:

AnnotatedTypeMirror

public static class AnnotatedTypeMirror.AnnotatedArrayType
extends AnnotatedTypeMirror

Represents Array types in java. A multidimensional array type is represented as an array type whose component type is also an array type.

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 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.AnnotatedArrayType	deepCopy() Returns a deep copy of this type with annotations.
AnnotatedTypeMirror.AnnotatedArrayType	deepCopy(boolean copyAnnotations) Returns a deep copy of this type.
AnnotatedTypeMirror	getComponentType()
AnnotatedTypeMirror.AnnotatedArrayType	getErased() Returns the erasure type of the this type, according to JLS specifications.
ArrayType	getUnderlyingType() Returns the underlying unannotated Java type, which this wraps.
void	setComponentType(AnnotatedTypeMirror type) Sets the component type of this array.
AnnotatedTypeMirror.AnnotatedArrayType	shallowCopy() Returns a shallow copy of this type with annotations.
AnnotatedTypeMirror.AnnotatedArrayType	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, directSuperTypes, equals, getAnnotation, getAnnotationInHierarchy, getAnnotations, getAnnotationsField, getEffectiveAnnotation, getEffectiveAnnotationInHierarchy, getEffectiveAnnotations, getExplicitAnnotations, getKind, 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

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

getUnderlyingType

public ArrayType getUnderlyingType()

Description copied from class: AnnotatedTypeMirror

Returns the underlying unannotated Java type, which this wraps.

Overrides:

getUnderlyingType in class AnnotatedTypeMirror

Returns:

the underlying type

setComponentType

public void setComponentType(AnnotatedTypeMirror type)

Sets the component type of this array.

Parameters:

type - the component type

getComponentType

public AnnotatedTypeMirror getComponentType()

Returns:

the component type of this array

deepCopy

public AnnotatedTypeMirror.AnnotatedArrayType 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.AnnotatedArrayType 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.AnnotatedArrayType 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.AnnotatedArrayType 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)

getErased

public AnnotatedTypeMirror.AnnotatedArrayType getErased()

Description copied from class: AnnotatedTypeMirror

Returns the erasure type of the this type, according to JLS specifications.

Overrides:

getErased in class AnnotatedTypeMirror

Returns:

the erasure of this AnnotatedTypeMirror, this is always a copy even if the erasure and the original type are equivalent

See Also:

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