Package org.checkerframework.checker.nullness

Class NullnessValue

java.lang.Object

org.checkerframework.framework.flow.CFAbstractValue<NullnessValue>

org.checkerframework.checker.nullness.NullnessValue

All Implemented Interfaces:

AbstractValue<NullnessValue>

public class NullnessValue
extends CFAbstractValue<NullnessValue>

Behaves just like CFValue, but additionally tracks whether at this point PolyNull is known to be NonNull or Nullable (or not known to be either).

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.framework.flow.CFAbstractValue

CFAbstractValue.AnnotationSetCombiner, CFAbstractValue.ValueGlb, CFAbstractValue.ValueLub

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isPolyNullNonNull	True if, at this point, PolyNull is known to be NonNull.
protected boolean	isPolyNullNull	True if, at this point, PolyNull is known to be Nullable.

Fields inherited from class org.checkerframework.framework.flow.CFAbstractValue

analysis, annotations, atypeFactory, qualHierarchy, underlyingType

Constructor Summary

Constructors

Constructor	Description
NullnessValue(CFAbstractAnalysis<NullnessValue,?,?> analysis, AnnotationMirrorSet annotations, TypeMirror underlyingType)	Creates a new NullnessValue.

Method Summary

Modifier and Type	Method	Description
String	toStringSimple()	Returns the string representation, using simple (not fully-qualified) names.
protected NullnessValue	upperBound(@Nullable NullnessValue other, TypeMirror upperBoundTypeMirror, boolean shouldWiden)	Returns an upper bound of this and other.

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

canBeMissingAnnotations, equals, getAnnotations, getUnderlyingType, greatestLowerBound, hashCode, leastUpperBound, leastUpperBound, mostSpecific, toString, toStringFullyQualified, validateSet, widenUpperBound

Methods inherited from class java.lang.Object

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

Field Details

isPolyNullNonNull

protected boolean isPolyNullNonNull

True if, at this point, PolyNull is known to be NonNull.

isPolyNullNull

protected boolean isPolyNullNull

True if, at this point, PolyNull is known to be Nullable.

Constructor Details

NullnessValue

public NullnessValue(CFAbstractAnalysis<NullnessValue,?,?> analysis,
 AnnotationMirrorSet annotations,
 TypeMirror underlyingType)

Creates a new NullnessValue.

Parameters:

analysis - the analysis

annotations - the annotations

underlyingType - the underlying type

Method Details

upperBound

protected NullnessValue upperBound(@Nullable NullnessValue other,
 TypeMirror upperBoundTypeMirror,
 boolean shouldWiden)

Description copied from class: CFAbstractValue

Returns an upper bound of this and other. The underlying type of the value returned is upperBoundTypeMirror. If shouldWiden is false, this method returns the least upper bound of this and other.

This is the implementation of CFAbstractValue.leastUpperBound(CFAbstractValue, TypeMirror), CFAbstractValue.leastUpperBound(CFAbstractValue), CFAbstractValue.widenUpperBound(CFAbstractValue), and CFAbstractValue.upperBound(CFAbstractValue, boolean). Subclasses may override it.

Overrides:

upperBound in class CFAbstractValue<NullnessValue>

Parameters:

other - an abstract value

upperBoundTypeMirror - the underlying type of the returned value

shouldWiden - true if the method should perform widening

Returns:

an upper bound of this and other

toStringSimple

@SideEffectFree
public String toStringSimple()

Description copied from class: CFAbstractValue

Returns the string representation, using simple (not fully-qualified) names.

Overrides:

toStringSimple in class CFAbstractValue<NullnessValue>

Returns:

the string representation, using simple (not fully-qualified) names