org.checkerframework.framework.type

Class AnnotatedTypeMirror.AnnotatedWildcardType

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeMirror

org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedWildcardType

Enclosing class:

AnnotatedTypeMirror

public static class AnnotatedTypeMirror.AnnotatedWildcardType
extends AnnotatedTypeMirror

Represents a wildcard type argument. Examples include:

? ? extends Number ? super T

A wildcard may have its upper bound explicitly set by an extends clause, its lower bound explicitly set by a super clause, or neither (but not both).

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.
void	addAnnotation(AnnotationMirror a) Adds an annotation to this type.
AnnotatedTypeMirror.AnnotatedWildcardType	deepCopy()
AnnotatedTypeMirror.AnnotatedWildcardType	deepCopy(boolean copyAnnotations) Returns a deep copy of this type.
AnnotatedTypeMirror	getErased() Returns the erasure type of the this type, according to JLS specifications.
AnnotatedTypeMirror	getExtendsBound()
AnnotatedTypeMirror	getExtendsBoundField()
AnnotatedTypeMirror	getSuperBound()
AnnotatedTypeMirror	getSuperBoundField()
TypeVariable	getTypeVariable() Returns the type variable to which this wildcard is an argument.
WildcardType	getUnderlyingType() Returns the underlying unannotated Java type, which this wraps
boolean	isUninferredTypeArgument() Returns whether or not this wildcard is a type argument for which inference failed to infer a type.
void	setUninferredTypeArgument() Set that this wildcard is from an uninferred type argument.
AnnotatedTypeMirror.AnnotatedWildcardType	shallowCopy() Returns a shallow copy of this type with annotations.
AnnotatedTypeMirror.AnnotatedWildcardType	shallowCopy(boolean copyAnnotations) Returns a shallow copy of this type.

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

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

addAnnotation

public void addAnnotation(AnnotationMirror a)

Description copied from class: AnnotatedTypeMirror

Adds an annotation to this type. Only annotations supported by the type factory are added.

Overrides:

addAnnotation in class AnnotatedTypeMirror

Parameters:

a - the annotation to add

getSuperBoundField

public AnnotatedTypeMirror getSuperBoundField()

getSuperBound

public AnnotatedTypeMirror getSuperBound()

Returns:

the lower bound of this wildcard. If no lower bound is explicitly declared, null is returned.

getExtendsBoundField

public AnnotatedTypeMirror getExtendsBoundField()

getExtendsBound

public AnnotatedTypeMirror getExtendsBound()

Returns:

the upper bound of this wildcard. If no upper bound is explicitly declared, the upper bound of the type variable to which the wildcard is bound is used.

getTypeVariable

public TypeVariable getTypeVariable()

Returns the type variable to which this wildcard is an argument. Used to initialize the upper bound of unbounded wildcards and wildcards in raw types.

Returns:

the type variable to which this wildcard is an argument

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 WildcardType 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.AnnotatedWildcardType 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.AnnotatedWildcardType deepCopy()

Specified by:

deepCopy in class AnnotatedTypeMirror

Returns:

a deep copy of this type with annotations

See Also:

AnnotatedTypeMirror.deepCopy(boolean)

shallowCopy

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

getErased

public AnnotatedTypeMirror 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:

AnnotatedTypeMirror.AnnotatedTypeVariable.getErased()

setUninferredTypeArgument

public void setUninferredTypeArgument()

Set that this wildcard is from an uninferred type argument. This method should only be used within the framework. Once issues that depend on this hack, in particular Issue 979, are fixed, this must be removed.

isUninferredTypeArgument

public boolean isUninferredTypeArgument()

Returns whether or not this wildcard is a type argument for which inference failed to infer a type.

Returns:

returns whether or not this wildcard is a type argument for which inference failed