checkers.types

Class AnnotatedTypeMirror.AnnotatedTypeVariable

@NonNull java.lang.Object

@Mutable checkers.types.AnnotatedTypeMirror

checkers.types.AnnotatedTypeMirror.AnnotatedTypeVariable

All Implemented Interfaces:

AnnotatedTypeMirror.AnnotatedReferenceType

Enclosing class:

AnnotatedTypeMirror

public static class AnnotatedTypeMirror.AnnotatedTypeVariable
extends @Mutable AnnotatedTypeMirror
implements AnnotatedTypeMirror.AnnotatedReferenceType

Represents a type variable. A type variable may be explicitly declared by a type parameter of a type, method, or constructor. A type variable may also be declared implicitly, as by the capture conversion of a wildcard type argument (see chapter 5 of The Java Language Specification, Third Edition).

Nested Class Summary

Nested classes/interfaces inherited from class checkers.types.AnnotatedTypeMirror

AnnotatedTypeMirror.AnnotatedArrayType, AnnotatedTypeMirror.AnnotatedDeclaredType, AnnotatedTypeMirror.AnnotatedExecutableType, AnnotatedTypeMirror.AnnotatedNoType, AnnotatedTypeMirror.AnnotatedNullType, AnnotatedTypeMirror.AnnotatedPrimitiveType, AnnotatedTypeMirror.AnnotatedReferenceType, AnnotatedTypeMirror.AnnotatedTypeVariable, AnnotatedTypeMirror.AnnotatedWildcardType

Field Summary

Fields inherited from class checkers.types.AnnotatedTypeMirror

annotationFactory, annotations, element, enclosingType, env, typeFactory, uid

Method Summary

Methods

Modifier and Type	Method and Description
<R extends @NonNull Object,P extends @NonNull Object> R	accept(AnnotatedTypeVisitor<R,P> v, P p) Applies a visitor to this type.
AnnotatedTypeMirror.AnnotatedTypeVariable	getCopy(boolean copyAnnotations) Returns a shallow copy of this type.
Set<@Nullable AnnotationMirror>	getEffectiveAnnotations() Returns the "effective" annotations on this type, i.e.
@Mutable AnnotatedTypeMirror	getEffectiveLowerBound()
@Mutable AnnotatedTypeMirror	getEffectiveUpperBound()
@Mutable AnnotatedTypeMirror	getErased() Returns the erasure type of the this type, according to JLS specifications.
@Mutable AnnotatedTypeMirror	getLowerBound()
@Mutable AnnotatedTypeMirror	getLowerBoundField() Get the lower bound field directly, bypassing any lazy initialization.
TypeVariable	getUnderlyingType() Returns the underlying unannotated Java type, which this wraps
@Mutable AnnotatedTypeMirror	getUpperBound() Get the upper bound of the type variable, possibly lazily initializing it.
@Mutable AnnotatedTypeMirror	getUpperBoundField() Get the upper bound field directly, bypassing any lazy initialization.
int	hashCode()
@Mutable AnnotatedTypeMirror	substitute(Map<? extends @Mutable AnnotatedTypeMirror,? extends @Mutable AnnotatedTypeMirror> mappings) Return a copy of this, with the given substitutions performed.
@ReadOnly String	toString(boolean printInvisible) A version of toString() that optionally outputs all type qualifiers, including @InvisibleQualifier's.

Methods inherited from class checkers.types.AnnotatedTypeMirror

addAnnotation, addAnnotation, addAnnotations, clearAnnotations, copyFields, createType, createTypeOfObject, directSuperTypes, directSuperTypes, equals, formatAnnotationString, getAnnotation, getAnnotation, getAnnotation, getAnnotationInHierarchy, getAnnotations, getElement, getEnclosingType, getExplicitAnnotations, getKind, hasAnnotation, hasAnnotation, hasAnnotationRelaxed, hasEffectiveAnnotation, hasEffectiveAnnotationRelaxed, hasExplicitAnnotation, hasExplicitAnnotation, hasExplicitAnnotationRelaxed, isAnnotated, isAnnotatedInHierarchy, isUnqualified, removeAnnotation, removeAnnotation, removeAnnotationInHierarchy, removeAnnotations, removeUnqualified, replaceAnnotation, replaceAnnotations, toString, toStringDebug

Methods inherited from class java.lang.Object

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

Method Detail

accept

public <R extends @NonNull Object,P extends @NonNull Object> R accept(AnnotatedTypeVisitor<R,P> v,
                                                             P p)

Description copied from class: AnnotatedTypeMirror

Applies a visitor to this type.

Specified by:

accept in class @Mutable 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 TypeVariable getUnderlyingType()

Description copied from class: AnnotatedTypeMirror

Returns the underlying unannotated Java type, which this wraps

Overrides:

getUnderlyingType in class @Mutable AnnotatedTypeMirror

Returns:

the underlying type

getLowerBoundField

public @Mutable AnnotatedTypeMirror getLowerBoundField()

Get the lower bound field directly, bypassing any lazy initialization. This method is necessary to prevent infinite recursions in initialization. In general, prefer getLowerBound.

Returns:

the lower bound field.

getLowerBound

public @Mutable AnnotatedTypeMirror getLowerBound()

Returns:

the lower bound type of this type variable

See Also:

#getEffectiveLowerBoundAnnotations

getEffectiveLowerBound

public @Mutable AnnotatedTypeMirror getEffectiveLowerBound()

Returns:

the effective lower bound: the lower bound, with annotations on the type variable considered.

getUpperBoundField

public @Mutable AnnotatedTypeMirror getUpperBoundField()

Get the upper bound field directly, bypassing any lazy initialization. This method is necessary to prevent infinite recursions in initialization. In general, prefer getUpperBound.

Returns:

the upper bound field.

getUpperBound

public @Mutable AnnotatedTypeMirror getUpperBound()

Get the upper bound of the type variable, possibly lazily initializing it. Attention: If the upper bound is lazily initialized, it will not contain any annotations! Callers of the method have to make sure that an AnnotatedTypeFactory first processed the bound.

Returns:

the upper bound type of this type variable

See Also:

#getEffectiveUpperBoundAnnotations

getEffectiveUpperBound

public @Mutable AnnotatedTypeMirror getEffectiveUpperBound()

Returns:

the effective upper bound: the upper bound, with annotations on the type variable considered.

getEffectiveAnnotations

public Set<@Nullable AnnotationMirror> getEffectiveAnnotations()

Description copied from class: AnnotatedTypeMirror

Returns the "effective" annotations on this type, i.e. the annotations on the type itself, or on the upper/extends bound of a type variable/wildcard.

Overrides:

getEffectiveAnnotations in class @Mutable AnnotatedTypeMirror

Returns:

a set of the annotations on this

getCopy

public AnnotatedTypeMirror.AnnotatedTypeVariable getCopy(boolean copyAnnotations)

Description copied from class: AnnotatedTypeMirror

Returns a shallow copy of this type.

Specified by:

getCopy in class @Mutable AnnotatedTypeMirror

Parameters:

copyAnnotations - whether copy should have annotations

getErased

public @Mutable AnnotatedTypeMirror getErased()

Description copied from class: AnnotatedTypeMirror

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

Overrides:

getErased in class @Mutable AnnotatedTypeMirror

Returns:

the erasure of this

substitute

public @Mutable AnnotatedTypeMirror substitute(Map<? extends @Mutable AnnotatedTypeMirror,? extends @Mutable AnnotatedTypeMirror> mappings)

Description copied from class: AnnotatedTypeMirror

Return a copy of this, with the given substitutions performed.

Overrides:

substitute in class @Mutable AnnotatedTypeMirror

toString

public @ReadOnly String toString(boolean printInvisible)

Description copied from class: AnnotatedTypeMirror

A version of toString() that optionally outputs all type qualifiers, including @InvisibleQualifier's.

Overrides:

toString in class @Mutable AnnotatedTypeMirror

Parameters:

printInvisible - Whether to always output invisible qualifiers.

Returns:

A string representation of the current type containing all qualifiers.

hashCode

public int hashCode()

Overrides:

hashCode in class @Mutable AnnotatedTypeMirror