org.checkerframework.framework.flow

Class CFAbstractValue.ValueLub

java.lang.Object

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.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 and Description
ValueLub(boolean shouldWiden) Creates a CFAbstractValue.ValueLub.

Method Summary

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

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 Detail

ValueLub

public ValueLub(boolean shouldWiden)

Creates a CFAbstractValue.ValueLub.

Parameters:

shouldWiden - if true, this class computes an upper bound

Method Detail

combineTwoAnnotations

protected @Nullable AnnotationMirror combineTwoAnnotations(AnnotationMirror a,
                                                           AnnotationMirror b,
                                                           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.AnnotationSetCombiner

Parameters:

a - an annotation in the hierarchy

b - an annotation in the hierarchy

top - the top annotation in the hierarchy

Returns:

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

combineNoAnnotations

protected @Nullable AnnotationMirror combineNoAnnotations(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 not primary annotation, the null is returned. This method is called when no annotation exists in either sets for the hierarchy whose top is top.

Specified by:

combineNoAnnotations in class CFAbstractValue.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

combineOneAnnotation

protected @Nullable AnnotationMirror combineOneAnnotation(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 on set, but not the other.

Specified by:

combineOneAnnotation in class CFAbstractValue.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