org.checkerframework.framework.type

Class AnnotatedTypeMirror.AnnotatedNullType

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeMirror

org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedNullType

Enclosing class:

AnnotatedTypeMirror

public static class AnnotatedTypeMirror.AnnotatedNullType
extends AnnotatedTypeMirror

Represents the null type. This is the type of the expression null.

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, 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.AnnotatedNullType	deepCopy()
AnnotatedTypeMirror.AnnotatedNullType	deepCopy(boolean copyAnnotations) Returns a deep copy of this type.
NullType	getUnderlyingType() Returns the underlying unannotated Java type, which this wraps
AnnotatedTypeMirror.AnnotatedNullType	shallowCopy() Returns a shallow copy of this type with annotations.
AnnotatedTypeMirror.AnnotatedNullType	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, getErased, 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 NullType 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.AnnotatedNullType 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.AnnotatedNullType deepCopy()

Specified by:

deepCopy in class AnnotatedTypeMirror

Returns:

a deep copy of this type with annotations

See Also:

AnnotatedTypeMirror.deepCopy(boolean)

shallowCopy

public AnnotatedTypeMirror.AnnotatedNullType 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.

shallowCopy

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