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
NullnessValue	leastUpperBound(@Nullable NullnessValue other)	Compute the least upper bound of two values.
String	toStringSimple()	Returns the string representation, using simple (not fully-qualified) names.

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

canBeMissingAnnotations, equals, getAnnotations, getUnderlyingType, greatestLowerBound, hashCode, 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

leastUpperBound

public NullnessValue leastUpperBound(@Nullable NullnessValue other)

Description copied from interface: AbstractValue

Compute the least upper bound of two values.

Important: This method must fulfill the following contract:

• Does not change this.
• Does not change other.
• Returns a fresh object which is not aliased yet.
• Returns an object of the same (dynamic) type as this, even if the signature is more permissive.
• Is commutative.

Specified by:

leastUpperBound in interface AbstractValue<NullnessValue>

Overrides:

leastUpperBound in class CFAbstractValue<NullnessValue>

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