Package org.checkerframework.framework.util.typeinference8.types

Class UseOfVariable

java.lang.Object

org.checkerframework.framework.util.typeinference8.types.AbstractType

org.checkerframework.framework.util.typeinference8.types.UseOfVariable

public class UseOfVariable
extends AbstractType

A use of an inference variable. This class keeps track of whether the use of this variable has a primary annotation.

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.framework.util.typeinference8.types.AbstractType

AbstractType.Kind

Field Summary

Fields inherited from class org.checkerframework.framework.util.typeinference8.types.AbstractType

context, functionType, ignoreAnnotations, typeFactory

Constructor Summary

Constructors

Constructor	Description
UseOfVariable(AnnotatedTypeMirror.AnnotatedTypeVariable type, Variable variable, AnnotationMirrorMap<QualifierVar> qualifierVars, Java8InferenceContext context, boolean ignoreAnnotations)	Creates a use of a variable.

Method Summary

Modifier and Type	Method	Description
void	addBound(Constraint parent, VariableBounds.BoundKind kind, AbstractType bound)	Adds a bound for this variable, if this use does not have a primary annotation.
void	addQualifierBound(VariableBounds.BoundKind kind, Set<AbstractQualifier> annotations)	Adds a qualifier bound for this variable, if this use does not have a primary annotation.
AbstractType	applyInstantiations()	Returns a new type that is the same as this one except the variables in instantiations have been replaced by their instantiation.
UseOfVariable	capture(Java8InferenceContext context)	Returns a new type that is the capture of this type.
AbstractType	create(AnnotatedTypeMirror atm, boolean ignoreAnnotations)	Creates a type using the given types.
boolean	equals(Object o)
AnnotatedTypeMirror.AnnotatedTypeVariable	getAnnotatedType()	Returns the underlying annotated type.
UseOfVariable	getErased()	Returns new type whose Java type is the erasure of this type.
Collection<Variable>	getInferenceVariables()	Returns a collection of all inference variables referenced by this type.
TypeVariable	getJavaType()	Returns the underlying Java type without inference variables.
AbstractType.Kind	getKind()	Returns the kind of AbstractType.
Set<AbstractQualifier>	getQualifiers()	Returns the primary qualifiers on this type.
@Nullable List<ProperType>	getTypeParameterBounds()	Assuming the type is a declared type, this method returns the upper bounds of its type parameters.
Variable	getVariable()	Returns the variable that this is a use of.
int	hashCode()
boolean	isObject()	Returns true if this type is java.lang.Object.
void	setHasThrowsBound(boolean hasThrowsBound)	Set whether this use has a throws bound.
String	toString()

Methods inherited from class org.checkerframework.framework.util.typeinference8.types.AbstractType

asSuper, checkAnnotationSubtype, create, getComponentType, getEnclosingType, getFunctionTypeParameterTypes, getFunctionTypeReturnType, getIntersectionBounds, getMostSpecificArrayType, getTypeArguments, getTypeKind, getTypeVarLowerBound, getTypeVarUpperBound, getWildcardLowerBound, getWildcardUpperBound, inferenceProblemHashCode, isFunctionalInterface, isInferenceType, isLowerBoundedWildcard, isLowerBoundTypeVariable, isParameterizedType, isPrimitiveArray, isProper, isRaw, isUnboundWildcard, isUpperBoundedWildcard, isUseOfVariable, isWildcardParameterizedType, replaceTypeArgs, sameInferenceProblem

Methods inherited from class java.lang.Object

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

Constructor Details

UseOfVariable

public UseOfVariable(AnnotatedTypeMirror.AnnotatedTypeVariable type,
 Variable variable,
 AnnotationMirrorMap<QualifierVar> qualifierVars,
 Java8InferenceContext context,
 boolean ignoreAnnotations)

Creates a use of a variable.

Parameters:

type - annotated type variable for this use

variable - variable that this is a use of

qualifierVars - a mapping from polymorphic annotation to QualifierVar

context - the context

ignoreAnnotations - true if the annotations on this type should be ignored

Method Details

create

public AbstractType create(AnnotatedTypeMirror atm,
 boolean ignoreAnnotations)

Description copied from class: AbstractType

Creates a type using the given types.

Specified by:

create in class AbstractType

Parameters:

atm - annotated type mirror

ignoreAnnotations - true if the annotations on this type should be ignored

Returns:

the new type

isObject

public boolean isObject()

Description copied from class: AbstractType

Returns true if this type is java.lang.Object.

Specified by:

isObject in class AbstractType

Returns:

true if this type is java.lang.Object

getTypeParameterBounds

public @Nullable List<ProperType> getTypeParameterBounds()

Assuming the type is a declared type, this method returns the upper bounds of its type parameters. (A type parameter of a declared type, can't refer to any type being inferred, so they are proper types.)

This implementation always returns a list. The return type is @Nullable only because getTypeParameterBounds() returns null.

An inference variable is not a declared type, so it has no type parameters; this implementation returns null.

Overrides:

getTypeParameterBounds in class AbstractType

Returns:

null, because this type is a use of an inference variable

capture

public UseOfVariable capture(Java8InferenceContext context)

Description copied from class: AbstractType

Returns a new type that is the capture of this type.

Overrides:

capture in class AbstractType

Parameters:

context - the context object

Returns:

a new type that is the capture of this type

getErased

public UseOfVariable getErased()

Description copied from class: AbstractType

Returns new type whose Java type is the erasure of this type.

Overrides:

getErased in class AbstractType

Returns:

a new type whose Java type is the erasure of this type

getJavaType

public TypeVariable getJavaType()

Description copied from class: AbstractType

Returns the underlying Java type without inference variables.

Specified by:

getJavaType in class AbstractType

Returns:

the underlying Java type without inference variables

getAnnotatedType

public AnnotatedTypeMirror.AnnotatedTypeVariable getAnnotatedType()

Description copied from class: AbstractType

Returns the underlying annotated type.

Specified by:

getAnnotatedType in class AbstractType

Returns:

the underlying annotated type

getKind

public AbstractType.Kind getKind()

Description copied from class: AbstractType

Returns the kind of AbstractType.

Specified by:

getKind in class AbstractType

Returns:

the kind of AbstractType

getInferenceVariables

public Collection<Variable> getInferenceVariables()

Description copied from class: AbstractType

Returns a collection of all inference variables referenced by this type.

Specified by:

getInferenceVariables in class AbstractType

Returns:

a collection of all inference variables referenced by this type

applyInstantiations

public AbstractType applyInstantiations()

Description copied from class: AbstractType

Returns a new type that is the same as this one except the variables in instantiations have been replaced by their instantiation.

Specified by:

applyInstantiations in class AbstractType

Returns:

a new type that is the same as this one except the variables in instantiations have been replaced by their instantiation

getVariable

public Variable getVariable()

Returns the variable that this is a use of.

Returns:

the variable that this is a use of

setHasThrowsBound

public void setHasThrowsBound(boolean hasThrowsBound)

Set whether this use has a throws bound.

Parameters:

hasThrowsBound - true if this use has a throws bound

addQualifierBound

public void addQualifierBound(VariableBounds.BoundKind kind,
 Set<AbstractQualifier> annotations)

Adds a qualifier bound for this variable, if this use does not have a primary annotation.

Parameters:

kind - the kind of bound

annotations - the qualifiers to add

addBound

public void addBound(Constraint parent,
 VariableBounds.BoundKind kind,
 AbstractType bound)

Adds a bound for this variable, if this use does not have a primary annotation.

Parameters:

parent - the constraint whose reduction created this bound

kind - the kind of bound

bound - the type of the bound

getQualifiers

public Set<AbstractQualifier> getQualifiers()

Description copied from class: AbstractType

Returns the primary qualifiers on this type.

Specified by:

getQualifiers in class AbstractType

Returns:

the primary qualifiers on this type

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Specified by:

equals in class AbstractType

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractType