Package org.checkerframework.framework.flow

Class CFAbstractValue.ValueLub

java.lang.Object

CFAbstractValue<V>.org.checkerframework.framework.flow.CFAbstractValue.AnnotationSetCombiner

org.checkerframework.framework.flow.CFAbstractValue.ValueLub

Enclosing class:

CFAbstractValue<V extends CFAbstractValue<V>>

protected class CFAbstractValue.ValueLub
extends CFAbstractValue<V>.AnnotationSetCombiner

Computes the least upper bound or, if shouldWiden is true, an upper bounds of two sets of annotations. The computation accounts for sets that are missing annotations in hierarchies.

Constructor Summary

Constructors

Constructor	Description
ValueLub(boolean shouldWiden)	Creates a CFAbstractValue<V extends CFAbstractValue<V>>.ValueLub.

Method Summary

Modifier and Type	Method	Description
protected @Nullable AnnotationMirror	combineAnnotationWithTypeVar(AnnotationMirror annotation, AnnotatedTypeMirror.AnnotatedTypeVariable typeVar, AnnotationMirror top, boolean canCombinedSetBeMissingAnnos)	Returns the result of combining annotation with typeVar.
protected @Nullable AnnotationMirror	combineTwoAnnotations(AnnotationMirror a, TypeMirror aTypeMirror, AnnotationMirror b, TypeMirror bTypeMirror, AnnotationMirror top)	Returns the result of combining the two annotations.
protected @Nullable AnnotationMirror	combineTwoTypeVars(AnnotatedTypeMirror.AnnotatedTypeVariable aAtv, AnnotatedTypeMirror.AnnotatedTypeVariable bAtv, AnnotationMirror top, boolean canCombinedSetBeMissingAnnos)	Returns the primary annotation that result from of combining the two AnnotatedTypeMirror.AnnotatedTypeVariable.

Methods inherited from class org.checkerframework.framework.flow.CFAbstractValue.AnnotationSetCombiner

combineSets

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ValueLub

public ValueLub(boolean shouldWiden)

Creates a CFAbstractValue<V extends CFAbstractValue<V>>.ValueLub.

Parameters:

shouldWiden - if true, this class computes an upper bound

Method Details

combineTwoAnnotations

protected @Nullable AnnotationMirror combineTwoAnnotations(AnnotationMirror a,
 TypeMirror aTypeMirror,
 AnnotationMirror b,
 TypeMirror bTypeMirror,
 AnnotationMirror top)

Description copied from class: CFAbstractValue.AnnotationSetCombiner

Returns the result of combining the two annotations. This method is called when an annotation exists in both sets for the hierarchy whose top is top.

Specified by:

combineTwoAnnotations in class CFAbstractValue<V extends CFAbstractValue<V>>.AnnotationSetCombiner

Parameters:

a - an annotation in the hierarchy

aTypeMirror - the type that is annotated by a

b - an annotation in the hierarchy

bTypeMirror - the type that is annotated by b

top - the top annotation in the hierarchy

Returns:

the result of combining the two annotations or null if no combination exists

combineTwoTypeVars

protected @Nullable AnnotationMirror combineTwoTypeVars(AnnotatedTypeMirror.AnnotatedTypeVariable aAtv,
 AnnotatedTypeMirror.AnnotatedTypeVariable bAtv,
 AnnotationMirror top,
 boolean canCombinedSetBeMissingAnnos)

Description copied from class: CFAbstractValue.AnnotationSetCombiner

Returns the primary annotation that result from of combining the two AnnotatedTypeMirror.AnnotatedTypeVariable. If the result has no primary annotation, null is returned. This method is called when no annotation exists in either sets for the hierarchy whose top is top.

Specified by:

combineTwoTypeVars in class CFAbstractValue<V extends CFAbstractValue<V>>.AnnotationSetCombiner

Parameters:

aAtv - a type variable that does not have a primary annotation in top hierarchy

bAtv - a type variable that does not have a primary annotation in top hierarchy

top - the top annotation in the hierarchy

canCombinedSetBeMissingAnnos - whether or not

Returns:

the result of combining the two type variables, which may be null

combineAnnotationWithTypeVar

protected @Nullable AnnotationMirror combineAnnotationWithTypeVar(AnnotationMirror annotation,
 AnnotatedTypeMirror.AnnotatedTypeVariable typeVar,
 AnnotationMirror top,
 boolean canCombinedSetBeMissingAnnos)

Description copied from class: CFAbstractValue.AnnotationSetCombiner

Returns the result of combining annotation with typeVar.

This is called when an annotation exists for the hierarchy in one set, but not the other.

Specified by:

combineAnnotationWithTypeVar in class CFAbstractValue<V extends CFAbstractValue<V>>.AnnotationSetCombiner

Parameters:

annotation - an annotation

typeVar - a type variable that does not have a primary annotation in the hierarchy

top - the top annotation of the hierarchy

canCombinedSetBeMissingAnnos - whether or not

Returns:

the result of combining annotation with typeVar