org.checkerframework.checker.nullness

Class NullnessAnnotatedTypeFactory

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeFactory

org.checkerframework.framework.type.GenericAnnotatedTypeFactory<Value,Store,Transfer,Flow>

org.checkerframework.checker.initialization.InitializationAnnotatedTypeFactory<NullnessValue,NullnessStore,NullnessTransfer,NullnessAnalysis>

org.checkerframework.checker.nullness.NullnessAnnotatedTypeFactory

All Implemented Interfaces:

org.checkerframework.javacutil.AnnotationProvider

public class NullnessAnnotatedTypeFactory
extends InitializationAnnotatedTypeFactory<NullnessValue,NullnessStore,NullnessTransfer,NullnessAnalysis>

The annotated type factory for the nullness type-system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	NullnessAnnotatedTypeFactory.NullnessPropagationAnnotator Nullness doesn't call propagation on binary and unary because the result is always @Initialized (the default qualifier).
protected class	NullnessAnnotatedTypeFactory.NullnessQualifierHierarchy
protected class	NullnessAnnotatedTypeFactory.NullnessTreeAnnotator
protected class	NullnessAnnotatedTypeFactory.NullnessTypeAnnotator

Nested classes/interfaces inherited from class org.checkerframework.checker.initialization.InitializationAnnotatedTypeFactory

InitializationAnnotatedTypeFactory.CommitmentTreeAnnotator, InitializationAnnotatedTypeFactory.CommitmentTypeAnnotator, InitializationAnnotatedTypeFactory.InitializationQualifierHierarchy

Nested classes/interfaces inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory

org.checkerframework.framework.type.GenericAnnotatedTypeFactory.ScanState

Nested classes/interfaces inherited from class org.checkerframework.framework.type.AnnotatedTypeFactory

org.checkerframework.framework.type.AnnotatedTypeFactory.InheritedFromClassAnnotator

Field Summary

Fields

Modifier and Type	Field and Description
protected CollectionToArrayHeuristics	collectionToArrayHeuristics
protected AnnotationMirror	MONOTONIC_NONNULL Annotation constants
protected AnnotationMirror	NONNULL Annotation constants
protected AnnotationMirror	NULLABLE Annotation constants
protected Set<Class<? extends Annotation>>	nullnessAnnos Cache for the nullness annotations
protected AnnotationMirror	POLYNULL Annotation constants
protected SystemGetPropertyHandler	systemGetPropertyHandler

Fields inherited from class org.checkerframework.checker.initialization.InitializationAnnotatedTypeFactory

COMMITTED, FBCBOTTOM, FREE, initAnnos, NOT_ONLY_COMMITTED, UNCLASSIFIED, useFbc

Fields inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory

analysis, cfgVisualizer, defaults, dependentTypesHelper, emptyStore, FLOW_BY_DEFAULT, flowResult, flowResultAnalysisCaches, initializationStaticStore, initializationStore, methodInvocationStores, poly, regularExitStores, returnStatementStores, scannedClasses, transfer, treeAnnotator, typeAnnotator

Fields inherited from class org.checkerframework.framework.type.AnnotatedTypeFactory

checker, elements, fromExpressionTreeCache, fromMemberTreeCache, fromTypeTreeCache, ignoreUninferredTypeArguments, loader, processingEnv, qualHierarchy, reflectionResolver, root, shouldCache, trees, typeArgumentInference, typeFormatter, typeHierarchy, types, typeVarSubstitutor, uid, visitorState

Constructor Summary

Constructors

Constructor and Description
NullnessAnnotatedTypeFactory(org.checkerframework.common.basetype.BaseTypeChecker checker, boolean useFbc)

Method Summary

Modifier and Type	Method and Description
void	adaptGetClassReturnTypeToReceiver(org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType getClassType, org.checkerframework.framework.type.AnnotatedTypeMirror receiverType)
protected org.checkerframework.framework.type.AnnotatedTypeFormatter	createAnnotatedTypeFormatter()
protected NullnessAnalysis	createFlowAnalysis(List<org.checkerframework.javacutil.Pair<VariableElement,NullnessValue>> fieldValues)
NullnessTransfer	createFlowTransferFunction(org.checkerframework.framework.flow.CFAbstractAnalysis<NullnessValue,NullnessStore,NullnessTransfer> analysis)
org.checkerframework.framework.type.QualifierHierarchy	createQualifierHierarchy(org.checkerframework.framework.util.MultiGraphQualifierHierarchy.MultiGraphFactory factory)
protected Set<Class<? extends Annotation>>	createSupportedTypeQualifiers()
protected org.checkerframework.framework.type.treeannotator.TreeAnnotator	createTreeAnnotator()
protected org.checkerframework.framework.type.typeannotator.TypeAnnotator	createTypeAnnotator()
AnnotationMirror	getFieldInvariantAnnotation() Returns the annotation that makes up the invariant of this commitment type system, such as @NonNull.
Set<Class<? extends Annotation>>	getInvalidConstructorReturnTypeAnnotations()
org.checkerframework.framework.type.AnnotatedTypeMirror	getMethodReturnType(MethodTree m, ReturnTree r)
Set<Class<? extends Annotation>>	getNullnessAnnotations()
List<VariableTree>	getUninitializedInvariantFields(NullnessStore store, TreePath path, boolean isStatic, List<? extends AnnotationMirror> receiverAnnotations) Returns the (non-static) fields that have the invariant annotation and are not yet initialized in a given store.
protected boolean	hasFieldInvariantAnnotation(org.checkerframework.framework.type.AnnotatedTypeMirror type) Returns whether or not type has the invariant annotation.
org.checkerframework.javacutil.Pair<org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType,List<org.checkerframework.framework.type.AnnotatedTypeMirror>>	methodFromUse(MethodInvocationTree tree)
protected void	replacePolyQualifier(org.checkerframework.framework.type.AnnotatedTypeMirror lhsType, Tree context) For types of left-hand side of an assignment, this method replaces PolyNull or PolyAll with Nullable if the org.checkerframework.dataflow analysis has determined that this is allowed soundly.

Methods inherited from class org.checkerframework.checker.initialization.InitializationAnnotatedTypeFactory

areAllFieldsCommittedOnly, createFreeAnnotation, createFreeAnnotation, createQualifierHierarchyFactory, createUnclassifiedAnnotation, createUnclassifiedAnnotation, getAnnotatedTypeLhs, getFreeOrRawAnnotationOfSuperType, getInitializationAnnotations, getInitializedInvariantFields, getSelfType, getTypeFrameFromAnnotation, hasFieldInvariantAnnotation, isCommitted, isCommitted, isFbcBottom, isFbcBottom, isFree, isFree, isInitializationAnnotation, isInitializedForFrame, isUnclassified, isUnclassified, postAsMemberOf, setSelfTypeInInitializationCode

Methods inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory

addCheckedCodeDefaults, addCheckedStandardDefaults, addComputedTypeAnnotations, addComputedTypeAnnotations, addComputedTypeAnnotations, addDefaultAnnotations, addTypeNameImplicit, addUncheckedCodeDefaults, addUncheckedStandardDefaults, analyze, applyInferredAnnotations, checkAndPerformFlowAnalysis, checkForDefaultQualifierInHierarchy, constructorFromUse, createAndInitQualifierDefaults, createCFGVisualizer, createDependentTypesHelper, createQualifierDefaults, createQualifierPolymorphism, fromNewClass, getAnnotatedTypeLhsNoTypeVarDefault, getAnnotatedTypeRhsUnaryAssign, getAnnotatedTypeVarargsArray, getAnnotationFromJavaExpressionString, getAnnotationFromReceiver, getAnnotationMirrorFromJavaExpressionString, getCFGVisualizer, getDependentTypesHelper, getEmptyStore, getFinalLocalValues, getFirstNodeOfKindForTree, getInferredValueFor, getMethodReturnType, getNodesForTree, getReceiverFromJavaExpressionString, getRegularExitStore, getResultingTypeOfConstructorMemberReference, getReturnStatementStores, getShouldDefaultTypeVarLocals, getSortedQualifierNames, getStoreAfter, getStoreAfter, getStoreAfter, getStoreBefore, getStoreBefore, getStoreBefore, getSupportedMonotonicTypeQualifiers, getTypeFactoryOfSubchecker, handleCFGViz, performFlowAnalysis, postDirectSuperTypes, postInit, preProcessClassTree, setRoot, typeVariablesFromUse

Methods inherited from class org.checkerframework.framework.type.AnnotatedTypeFactory

addAliasedAnnotation, addAliasedAnnotation, addAliasedAnnotation, addAliasedAnnotation, addAliasedDeclAnnotation, addAnnotationFromFieldInvariant, addInheritedAnnotation, aliasedAnnotation, annotateInheritedFromClass, annotateInheritedFromClass, checkInvalidOptionsInferSignatures, createAnnotationClassLoader, createAnnotationFormatter, createQualifierHierarchy, createQualifierHierarchy, createTypeArgumentInference, createTypeHierarchy, createTypeVariableSubstitutor, declarationFromElement, fromElement, fromElement, fromElement, getAnnotatedNullType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedTypeFormatter, getAnnotatedTypeFromTypeTree, getAnnotationFormatter, getAnnotationMirror, getAnnotationWithMetaAnnotation, getBoxedType, getBundledTypeQualifiersWithoutPolyAll, getBundledTypeQualifiersWithPolyAll, getCacheSize, getContext, getCurrentClassTree, getCurrentClassType, getCurrentMethodReceiver, getDeclAnnotation, getDeclAnnotationNoAliases, getDeclAnnotations, getDeclAnnotationWithMetaAnnotation, getElementUtils, getEnclosingMethod, getEnclosingType, getFieldInvariantAnnotationTree, getFieldInvariantDeclarationAnnotations, getFieldInvariants, getFnInterfaceFromTree, getFnInterfaceFromTree, getImplicitReceiverType, getNarrowedPrimitive, getPath, getProcessingEnv, getQualifierHierarchy, getReceiverType, getStringType, getSupportedTypeQualifiers, getTreeUtils, getTypeArgumentInference, getTypeHierarchy, getTypeVarSubstitutor, getUnboxedType, getUninferredWildcardType, getVisitorState, getWholeProgramInference, initializeReflectionResolution, isAnyEnclosingThisDeref, isFromByteCode, isFromStubFile, isMostEnclosingThisDeref, isSupportedQualifier, isWithinConstructor, methodFromUse, parseStubFiles, postProcessClassTree, postTypeVarSubstitution, setPathHack, toAnnotatedType, toString, type, widenToUpperBound

Methods inherited from class java.lang.Object

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

Field Detail

NONNULL

protected final AnnotationMirror NONNULL

Annotation constants

NULLABLE

protected final AnnotationMirror NULLABLE

Annotation constants

POLYNULL

protected final AnnotationMirror POLYNULL

Annotation constants

MONOTONIC_NONNULL

protected final AnnotationMirror MONOTONIC_NONNULL

Annotation constants

systemGetPropertyHandler

protected final SystemGetPropertyHandler systemGetPropertyHandler

collectionToArrayHeuristics

protected final CollectionToArrayHeuristics collectionToArrayHeuristics

nullnessAnnos

protected final Set<Class<? extends Annotation>> nullnessAnnos

Cache for the nullness annotations

Constructor Detail

NullnessAnnotatedTypeFactory

public NullnessAnnotatedTypeFactory(org.checkerframework.common.basetype.BaseTypeChecker checker,
                                    boolean useFbc)

Method Detail

createSupportedTypeQualifiers

protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers()

Overrides:

createSupportedTypeQualifiers in class org.checkerframework.framework.type.AnnotatedTypeFactory

replacePolyQualifier

protected void replacePolyQualifier(org.checkerframework.framework.type.AnnotatedTypeMirror lhsType,
                                    Tree context)

For types of left-hand side of an assignment, this method replaces PolyNull or PolyAll with Nullable if the org.checkerframework.dataflow analysis has determined that this is allowed soundly. For example:

 @PolyNull String foo(@PolyNull String param) {
    if (param == null) {
        //  @PolyNull is really @Nullable, so change
        // the type of param to @Nullable.
        param = null;
    }
    return param;
 }
 

Parameters:

lhsType - type to replace whose polymorphic qualifier will be replaced

context - tree used to get dataflow value

getUninitializedInvariantFields

public List<VariableTree> getUninitializedInvariantFields(NullnessStore store,
                                                          TreePath path,
                                                          boolean isStatic,
                                                          List<? extends AnnotationMirror> receiverAnnotations)

Description copied from class: InitializationAnnotatedTypeFactory

Returns the (non-static) fields that have the invariant annotation and are not yet initialized in a given store.

Overrides:

getUninitializedInvariantFields in class InitializationAnnotatedTypeFactory<NullnessValue,NullnessStore,NullnessTransfer,NullnessAnalysis>

createFlowAnalysis

protected NullnessAnalysis createFlowAnalysis(List<org.checkerframework.javacutil.Pair<VariableElement,NullnessValue>> fieldValues)

Overrides:

createFlowAnalysis in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<NullnessValue,NullnessStore,NullnessTransfer,NullnessAnalysis>

createFlowTransferFunction

public NullnessTransfer createFlowTransferFunction(org.checkerframework.framework.flow.CFAbstractAnalysis<NullnessValue,NullnessStore,NullnessTransfer> analysis)

Overrides:

createFlowTransferFunction in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<NullnessValue,NullnessStore,NullnessTransfer,NullnessAnalysis>

createAnnotatedTypeFormatter

protected org.checkerframework.framework.type.AnnotatedTypeFormatter createAnnotatedTypeFormatter()

Overrides:

createAnnotatedTypeFormatter in class org.checkerframework.framework.type.AnnotatedTypeFactory

Returns:

an AnnotatedTypeFormatter that does not print the qualifiers on null literals

methodFromUse

public org.checkerframework.javacutil.Pair<org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType,List<org.checkerframework.framework.type.AnnotatedTypeMirror>> methodFromUse(MethodInvocationTree tree)

Overrides:

methodFromUse in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<NullnessValue,NullnessStore,NullnessTransfer,NullnessAnalysis>

adaptGetClassReturnTypeToReceiver

public void adaptGetClassReturnTypeToReceiver(org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedExecutableType getClassType,
                                              org.checkerframework.framework.type.AnnotatedTypeMirror receiverType)

Overrides:

adaptGetClassReturnTypeToReceiver in class org.checkerframework.framework.type.AnnotatedTypeFactory

getMethodReturnType

public org.checkerframework.framework.type.AnnotatedTypeMirror getMethodReturnType(MethodTree m,
                                                                                   ReturnTree r)

Overrides:

getMethodReturnType in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<NullnessValue,NullnessStore,NullnessTransfer,NullnessAnalysis>

createTypeAnnotator

protected org.checkerframework.framework.type.typeannotator.TypeAnnotator createTypeAnnotator()

Overrides:

createTypeAnnotator in class InitializationAnnotatedTypeFactory<NullnessValue,NullnessStore,NullnessTransfer,NullnessAnalysis>

createTreeAnnotator

protected org.checkerframework.framework.type.treeannotator.TreeAnnotator createTreeAnnotator()

Overrides:

createTreeAnnotator in class InitializationAnnotatedTypeFactory<NullnessValue,NullnessStore,NullnessTransfer,NullnessAnalysis>

getNullnessAnnotations

public Set<Class<? extends Annotation>> getNullnessAnnotations()

Returns:

the list of annotations of the non-null type system

getInvalidConstructorReturnTypeAnnotations

public Set<Class<? extends Annotation>> getInvalidConstructorReturnTypeAnnotations()

Overrides:

getInvalidConstructorReturnTypeAnnotations in class InitializationAnnotatedTypeFactory<NullnessValue,NullnessStore,NullnessTransfer,NullnessAnalysis>

Returns:

the list of annotations that is forbidden for the constructor return type

getFieldInvariantAnnotation

public AnnotationMirror getFieldInvariantAnnotation()

Description copied from class: InitializationAnnotatedTypeFactory

Returns the annotation that makes up the invariant of this commitment type system, such as @NonNull.

Specified by:

getFieldInvariantAnnotation in class InitializationAnnotatedTypeFactory<NullnessValue,NullnessStore,NullnessTransfer,NullnessAnalysis>

Returns:

the invariant annotation for this type system

hasFieldInvariantAnnotation

protected boolean hasFieldInvariantAnnotation(org.checkerframework.framework.type.AnnotatedTypeMirror type)

Returns whether or not type has the invariant annotation.

If the type is a type variable, this method returns true if any possible instantiation of the type parameter could have the invariant annotation. See InitializationAnnotatedTypeFactory.hasFieldInvariantAnnotation(VariableTree) for an example.

In other words, is the lower bound @NonNull?

Specified by:

hasFieldInvariantAnnotation in class InitializationAnnotatedTypeFactory<NullnessValue,NullnessStore,NullnessTransfer,NullnessAnalysis>

Parameters:

type - of field that might have invariant annotation

Returns:

whether or not type has the invariant annotation

createQualifierHierarchy

public org.checkerframework.framework.type.QualifierHierarchy createQualifierHierarchy(org.checkerframework.framework.util.MultiGraphQualifierHierarchy.MultiGraphFactory factory)

Overrides:

createQualifierHierarchy in class org.checkerframework.framework.type.AnnotatedTypeFactory