Package org.checkerframework.checker.initialization

Class InitializationParentAnnotatedTypeFactory

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeFactory

org.checkerframework.framework.type.GenericAnnotatedTypeFactory<CFValue,InitializationStore,InitializationTransfer,InitializationAnalysis>

org.checkerframework.checker.initialization.InitializationParentAnnotatedTypeFactory

All Implemented Interfaces:

AnnotationProvider

Direct Known Subclasses:

InitializationAnnotatedTypeFactory, InitializationFieldAccessAnnotatedTypeFactory

public abstract class InitializationParentAnnotatedTypeFactory
extends GenericAnnotatedTypeFactory<CFValue,InitializationStore,InitializationTransfer,InitializationAnalysis>

Superclass for InitializationFieldAccessAnnotatedTypeFactory and InitializationAnnotatedTypeFactory to contain common functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	InitializationParentAnnotatedTypeFactory.CommitmentTreeAnnotator	This tree annotator modifies the propagation tree annotator to add propagation rules for the freedom-before-commitment system.
protected class	InitializationParentAnnotatedTypeFactory.CommitmentTypeAnnotator	This type annotator adds the correct UnderInitialization annotation to super constructors.
protected class	InitializationParentAnnotatedTypeFactory.InitializationQualifierHierarchy	The QualifierHierarchy for the initialization type system.

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

GenericAnnotatedTypeFactory.ScanState

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

AnnotatedTypeFactory.CapturedTypeVarSubstitutor, AnnotatedTypeFactory.ParameterizedExecutableType

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	assumeInitialized	The value of the assumeInitialized option.
protected final AnnotationMirror	FBCBOTTOM	FBCBottom.
protected final AnnotationMirror	INITIALIZED	Initialized.
protected final AnnotationMirror	NOT_ONLY_INITIALIZED	NotOnlyInitialized or null.
protected final TypeMirror	objectTypeMirror	The java.lang.Object type.
protected final AnnotationMirror	POLY_INITIALIZED	PolyInitialized.
protected final AnnotationMirror	UNDER_INITALIZATION	UnderInitialization or null.
protected final ExecutableElement	underInitializationValueElement	The UnderInitialization.value field/element.
protected final AnnotationMirror	UNKNOWN_INITIALIZATION	UnknownInitialization.
protected final ExecutableElement	unknownInitializationValueElement	The UnknownInitialization.value field/element.
protected final ExecutableElement	unusedWhenElement	The Unused.when field/element.

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

analysis, arraysAreRelevant, cfgVisualizer, contractsUtils, defaults, dependentTypesHelper, emptyStore, exceptionalExitStores, flowByDefault, flowResult, flowResultAnalysisCaches, formalParameterPattern, hasOrIsSubchecker, initializationStaticStore, initializationStore, poly, regularExitStores, relevantJavaTypes, returnStatementStores, scannedClasses, shouldClearSubcheckerSharedCFGs, sideEffectsUnrefineAliases, subcheckerSharedCFG, transfer, treeAnnotator, typeAnnotator

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

ajavaTypes, annotatedForValueElement, capturedTypeVarSubstitutor, checker, currentFileAjavaTypes, elements, ensuresQualifierExpressionElement, ensuresQualifierIfExpressionElement, ensuresQualifierIfListTM, ensuresQualifierIfListValueElement, ensuresQualifierIfResultElement, ensuresQualifierIfTM, ensuresQualifierListTM, ensuresQualifierListValueElement, ensuresQualifierTM, fieldInvariantFieldElement, fieldInvariantQualifierElement, fromExpressionTreeCache, fromMemberTreeCache, fromTypeTreeCache, hasQualifierParameterValueElement, ignoreRawTypeArguments, loader, methodValClassNameElement, methodValMethodNameElement, methodValParamsElement, noQualifierParameterValueElement, objectGetClass, processingEnv, qualHierarchy, qualifierUpperBounds, reflectionResolver, requiresQualifierExpressionElement, requiresQualifierListTM, requiresQualifierListValueElement, requiresQualifierTM, shouldCache, stubTypes, trees, typeArgumentInference, typeFormatter, typeHierarchy, typeInformationPresenter, types, typeVarSubstitutor, uid, viewpointAdapter

Constructor Summary

Constructors

Constructor	Description
InitializationParentAnnotatedTypeFactory(BaseTypeChecker checker)	Create a new InitializationParentAnnotatedTypeFactory.

Method Summary

Modifier and Type	Method	Description
protected boolean	areAllFieldsInitializedOnly(ClassTree classTree)	Are all fields initialized-only?
InitializationTransfer	createFlowTransferFunction(CFAbstractAnalysis<CFValue,InitializationStore,InitializationTransfer> analysis)	Returns the appropriate transfer function that is used for the given org.checkerframework.dataflow analysis.
protected QualifierHierarchy	createQualifierHierarchy()	Returns the QualifierHierarchy to be used by this checker.
protected Set<Class<? extends Annotation>>	createSupportedTypeQualifiers()	Returns a mutable set of annotation classes that are supported by a checker.
protected TreeAnnotator	createTreeAnnotator()	Returns a TreeAnnotator that adds annotations to a type based on the contents of a tree.
protected TypeAnnotator	createTypeAnnotator()	Returns a DefaultForTypeAnnotator that adds annotations to a type based on the content of the type itself.
AnnotationMirror	createUnderInitializationAnnotation(Class<?> typeFrame)	Creates a UnderInitialization annotation with the given type frame.
AnnotationMirror	createUnderInitializationAnnotation(TypeMirror typeFrame)	Creates a UnderInitialization annotation with the given type as its type frame argument.
AnnotationMirror	createUnknownInitializationAnnotation(Class<?> typeFrame)	Creates a UnknownInitialization annotation with a given type frame.
AnnotationMirror	createUnknownInitializationAnnotation(TypeMirror typeFrame)	Creates an UnknownInitialization annotation with a given type frame.
List<VariableTree>	getInitializedFields(InitializationStore store, TreePath path)	Returns the fields that are initialized in the given store.
@Nullable AnnotatedTypeMirror.AnnotatedDeclaredType	getSelfType(Tree tree)	Returns the type of this at the location of tree.
TypeMirror	getTypeFrameFromAnnotation(AnnotationMirror annotation)	Returns the type frame (that is, the argument) of a given initialization annotation.
protected AnnotationMirror	getUnderInitializationAnnotationOfSuperType(TypeMirror type)	Returns an UnderInitialization annotation that has the superclass of type as type frame.
List<VariableTree>	getUninitializedFields(InitializationStore store, TreePath path, boolean isStatic, Collection<? extends AnnotationMirror> receiverAnnotations)	Returns the fields that are possibly uninitialized in a given store, without taking into account the target checker.
boolean	isFbcBottom(AnnotationMirror anno)	Is anno the bottom annotation?
boolean	isFbcBottom(AnnotatedTypeMirror anno)	Does anno have the bottom annotation?
boolean	isImmutable(TypeMirror type)	Returns true.
boolean	isInitialized(AnnotationMirror anno)	Is anno the Initialized annotation?
boolean	isInitialized(AnnotatedTypeMirror anno)	Does anno have the annotation Initialized?
boolean	isInitializedForFrame(AnnotatedTypeMirror type, TypeMirror frame)	Return true if the type is initialized with respect to the given frame -- that is, all of the fields of the frame are initialized.
boolean	isNotFullyInitializedReceiver(MethodTree methodTree)	Returns true if the receiver of a method or constructor might not be fully initialized.
boolean	isUnderInitialization(AnnotationMirror anno)	Is anno the UnderInitialization annotation (with any type frame)?
boolean	isUnderInitialization(AnnotatedTypeMirror anno)	Does anno have the annotation UnderInitialization (with any type frame)?
boolean	isUnknownInitialization(AnnotationMirror anno)	Is anno the UnknownInitialization annotation (with any type frame)?
boolean	isUnknownInitialization(AnnotatedTypeMirror anno)	Does anno have the annotation UnknownInitialization (with any type frame)?
protected boolean	isUnused(VariableTree field, Collection<? extends AnnotationMirror> receiverAnnos)	Returns whether the specified field is unused, given the specified annotations on the receiver.
protected AnnotatedTypeFactory.ParameterizedExecutableType	methodFromUse(ExpressionTree tree, ExecutableElement methodElt, AnnotatedTypeMirror receiverType, boolean inferTypeArgs)	The implementation of AnnotatedTypeFactory.methodFromUse(ExpressionTree, ExecutableElement, AnnotatedTypeMirror) and AnnotatedTypeFactory.methodFromUseWithoutTypeArgInference(ExpressionTree, ExecutableElement, AnnotatedTypeMirror).
void	postAsMemberOf(AnnotatedTypeMirror type, AnnotatedTypeMirror owner, Element element)	A callback method for the AnnotatedTypeFactory subtypes to customize AnnotatedTypes.asMemberOf().
protected void	setSelfTypeInInitializationCode(Tree tree, AnnotatedTypeMirror.AnnotatedDeclaredType selfType, TreePath path)	Side-effects argument selfType to make it @Initialized or @UnderInitialization, depending on whether all fields have been set.
boolean	shouldWarnIfStubRedundantWithBytecode()	Returns false.

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

addAnnotationsFromDefaultForType, addCheckedCodeDefaults, addCheckedStandardDefaults, addComputedTypeAnnotations, addComputedTypeAnnotations, addComputedTypeAnnotations, addComputedTypeAnnotationsWithoutFlow, addDefaultAnnotations, addSharedCFGForTree, addUncheckedStandardDefaults, analyze, annotationsForIrrelevantJavaType, applyInferredAnnotations, applyQualifierParameterDefaults, applyQualifierParameterDefaults, checkAndPerformFlowAnalysis, checkForDefaultQualifierInHierarchy, constructorFromUse, constructorFromUsePreSubstitution, createAndInitQualifierDefaults, createCFGVisualizer, createContractsFromMethod, createDefaultForTypeAnnotator, createDefaultForUseTypeAnnotator, createDependentTypesHelper, createFlowAnalysis, createQualifierDefaults, createQualifierPolymorphism, createRequiresOrEnsuresQualifier, getAnnotatedTypeBefore, getAnnotatedTypeLhs, getAnnotatedTypeLhsNoTypeVarDefault, getAnnotatedTypeRhsUnaryAssign, getAnnotatedTypeVarargsArray, getAnnotationFromJavaExpression, getAnnotationFromJavaExpressionString, getAnnotationMirrorFromJavaExpressionString, getAnnotationsFromJavaExpression, getCFGVisualizer, getContractExpressions, getContractsFromMethod, getDefaultAnnotations, getDefaultForTypeAnnotator, getDefaultValueAnnotatedType, getDependentTypesHelper, getEmptyStore, getEnsuresQualifierIfResult, getExceptionalExitStore, getExplicitNewClassAnnos, getExplicitNewClassClassTypeArgs, getExpressionAndOffsetFromJavaExpressionString, getFinalLocalValues, getFirstNodeOfKindForTree, getInferredValueFor, getMethodReturnType, getNodesForTree, getQualifierPolymorphism, getRegularExitStore, getReturnStatementStores, getSharedCFGForTree, getShouldDefaultTypeVarLocals, getSortedQualifierNames, getStoreAfter, getStoreAfter, getStoreAfter, getStoreBefore, getStoreBefore, getStoreBefore, getSupportedMonotonicTypeQualifiers, getTypeFactoryOfSubchecker, getTypeFactoryOfSubcheckerOrNull, getUseFlow, handleCFGViz, irrelevantExtraMessage, isComputingAnnotatedTypeMirrorOfLhs, isIgnoredExceptionType, isRelevant, isRelevant, isRelevantImpl, methodFromUse, methodFromUsePreSubstitution, parseJavaExpressionString, performFlowAnalysis, postAnalyze, postDirectSuperTypes, postInit, preProcessClassTree, setRoot, typeVariablesFromUse

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

adaptGetClassReturnTypeToReceiver, addAliasedDeclAnnotation, addAliasedDeclAnnotation, addAliasedTypeAnnotation, addAliasedTypeAnnotation, addAliasedTypeAnnotation, addAliasedTypeAnnotation, addAnnotationFromFieldInvariant, addInheritedAnnotation, applyCaptureConversion, applyCaptureConversion, applyUnboxing, areSameByClass, binaryTreeArgTypes, binaryTreeArgTypes, canonicalAnnotation, compoundAssignmentTreeArgTypes, constructorFromUse, constructorFromUseWithoutTypeArgInference, containsCapturedTypes, containsSameByClass, createAnnotatedTypeFormatter, createAnnotationClassLoader, createAnnotationFormatter, createQualifierUpperBounds, createTypeArgumentInference, createTypeHierarchy, createTypeInformationPresenter, createTypeVariableSubstitutor, createViewpointAdapter, declarationFromElement, doesAnnotatedForApplyToThisChecker, fromElement, fromElement, fromElement, getAnnotatedNullType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedTypeFormatter, getAnnotatedTypeFromTypeTree, getAnnotationByClass, getAnnotationFormatter, getAnnotationMirror, getAnnotationOrTypeDeclarationBound, getAnnotationWithMetaAnnotation, getBoxedType, getBundledTypeQualifiers, getCacheSize, getChecker, getCheckerNames, getContractExpressions, getContractListValues, getDeclAnnotation, getDeclAnnotationNoAliases, getDeclAnnotations, getDeclAnnotationWithMetaAnnotation, getDefaultTypeDeclarationBounds, getDummyAssignedTo, getElementUtils, getEnclosingClassOrMethod, getEnclosingSubType, getEnclosingType, getEnumConstructorQualifiers, getExpressionAndOffset, getFieldInvariantAnnotationTree, getFieldInvariantDeclarationAnnotations, getFieldInvariants, getFnInterfaceFromTree, getFunctionTypeFromTree, getFunctionTypeFromTree, getImplicitReceiverType, getIterableElementType, getIterableElementType, getMethodReturnType, getNarrowedAnnotations, getNarrowedPrimitive, getPath, getProcessingEnv, getQualifierHierarchy, getQualifierParameterHierarchies, getQualifierParameterHierarchies, getQualifierUpperBounds, getReceiverType, getResultingTypeOfConstructorMemberReference, getRoot, getStringType, getSupportedTypeQualifierNames, getSupportedTypeQualifiers, getTreeUtils, getTypeArgumentInference, getTypeDeclarationBounds, getTypeHierarchy, getTypeOfExtendsImplements, getTypeVarSubstitutor, getUnboxedType, getVisitorTreePath, getWidenedAnnotations, getWidenedType, getWidenedType, hasExplicitNoQualifierParameterInHierarchy, hasExplicitQualifierParameterInHierarchy, hasQualifierParameterInHierarchy, hasQualifierParameterInHierarchy, initializeAtm, initializeReflectionResolution, isDeterministic, isFromByteCode, isFromStubFile, isSideEffectFree, isSupportedQualifier, isSupportedQualifier, isSupportedQualifier, isWithinConstructor, mergeAnnotationFileAnnosIntoType, methodFromUse, methodFromUse, methodFromUseWithoutTypeArgInference, methodFromUseWithoutTypeArgInference, negateConstant, order, parseAnnotationFiles, postProcessClassTree, replaceAnnotations, replaceAnnotations, setPathForArtificialTree, setVisitorTreePath, toAnnotatedType, toString, type

Methods inherited from class java.lang.Object

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

Field Details

UNKNOWN_INITIALIZATION

protected final AnnotationMirror UNKNOWN_INITIALIZATION

UnknownInitialization.

INITIALIZED

protected final AnnotationMirror INITIALIZED

Initialized.

UNDER_INITALIZATION

protected final AnnotationMirror UNDER_INITALIZATION

UnderInitialization or null.

NOT_ONLY_INITIALIZED

protected final AnnotationMirror NOT_ONLY_INITIALIZED

NotOnlyInitialized or null.

POLY_INITIALIZED

protected final AnnotationMirror POLY_INITIALIZED

PolyInitialized.

FBCBOTTOM

protected final AnnotationMirror FBCBOTTOM

FBCBottom.

objectTypeMirror

protected final TypeMirror objectTypeMirror

The java.lang.Object type.

unusedWhenElement

protected final ExecutableElement unusedWhenElement

The Unused.when field/element.

underInitializationValueElement

protected final ExecutableElement underInitializationValueElement

The UnderInitialization.value field/element.

unknownInitializationValueElement

protected final ExecutableElement unknownInitializationValueElement

The UnknownInitialization.value field/element.

assumeInitialized

protected final boolean assumeInitialized

The value of the assumeInitialized option.

Constructor Details

InitializationParentAnnotatedTypeFactory

public InitializationParentAnnotatedTypeFactory(BaseTypeChecker checker)

Create a new InitializationParentAnnotatedTypeFactory.

Don't forget to call GenericAnnotatedTypeFactory.postInit() in the concrete subclass.

Parameters:

checker - the checker to which the new type factory belongs

Method Details

postAsMemberOf

public void postAsMemberOf(AnnotatedTypeMirror type,
 AnnotatedTypeMirror owner,
 Element element)

Description copied from class: AnnotatedTypeFactory

A callback method for the AnnotatedTypeFactory subtypes to customize AnnotatedTypes.asMemberOf(). Overriding methods should merely change the annotations on the subtypes, without changing the types.

Overrides:

postAsMemberOf in class GenericAnnotatedTypeFactory<CFValue,InitializationStore,InitializationTransfer,InitializationAnalysis>

Parameters:

type - the annotated type of the element

owner - the annotated type of the receiver of the accessing tree

element - the element of the field or method

createSupportedTypeQualifiers

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

Description copied from class: AnnotatedTypeFactory

Returns a mutable set of annotation classes that are supported by a checker.

Subclasses may override this method to return a mutable set of their supported type qualifiers through one of the 5 approaches shown below.

Subclasses should not call this method; they should call AnnotatedTypeFactory.getSupportedTypeQualifiers() instead.

By default, a checker supports all annotations located in a subdirectory called qual that's located in the same directory as the checker. Note that only annotations defined with the @Target({ElementType.TYPE_USE}) meta-annotation (and optionally with the additional value of ElementType.TYPE_PARAMETER, but no other ElementType values) are automatically considered as supported annotations.

To support a different set of annotations than those in the qual subdirectory, or that have other ElementType values, see examples below.

In total, there are 5 ways to indicate annotations that are supported by a checker:

1. Only support annotations located in a checker's qual directory:

   This is the default behavior. Simply place those annotations within the qual directory.

2. Support annotations located in a checker's qual directory and a list of other annotations:

   Place those annotations within the qual directory, and override AnnotatedTypeFactory.createSupportedTypeQualifiers() by calling AnnotatedTypeFactory.getBundledTypeQualifiers(Class...) with a varargs parameter list of the other annotations. Code example:

    @Override protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers() {
         return getBundledTypeQualifiers(Regex.class, PartialRegex.class, RegexBottom.class, UnknownRegex.class);
     } 
    

3. Supporting only annotations that are explicitly listed: Override AnnotatedTypeFactory.createSupportedTypeQualifiers() and return a mutable set of the supported annotations. Code example:

    @Override protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers() {
         return new HashSet<Class<? extends Annotation>>(
                 Arrays.asList(A.class, B.class));
     } 
    

   The set of qualifiers returned by AnnotatedTypeFactory.createSupportedTypeQualifiers() must be a fresh, mutable set. The methods AnnotatedTypeFactory.getBundledTypeQualifiers(Class...) must return a fresh, mutable set

Overrides:

createSupportedTypeQualifiers in class AnnotatedTypeFactory

Returns:

the type qualifiers supported this processor, or an empty set if none

createFlowTransferFunction

public InitializationTransfer createFlowTransferFunction(CFAbstractAnalysis<CFValue,InitializationStore,InitializationTransfer> analysis)

Description copied from class: GenericAnnotatedTypeFactory

Returns the appropriate transfer function that is used for the given org.checkerframework.dataflow analysis.

This implementation uses the checker naming convention to create the appropriate transfer function. If no transfer function is found, it returns an instance of CFTransfer.

Subclasses have to override this method to create the appropriate transfer function if they do not follow the checker naming convention.

Overrides:

createFlowTransferFunction in class GenericAnnotatedTypeFactory<CFValue,InitializationStore,InitializationTransfer,InitializationAnalysis>

Parameters:

analysis - a dataflow analysis

Returns:

a new transfer function

isImmutable

public boolean isImmutable(TypeMirror type)

Returns true. Initialization cannot be undone, i.e., an @Initialized object always stays @Initialized, an @UnderInitialization(A) object always stays @UnderInitialization(A) (though it may additionally become @Initialized), etc.

Overrides:

isImmutable in class AnnotatedTypeFactory

Parameters:

type - type to test

Returns:

true if the type is immutable

createUnderInitializationAnnotation

public AnnotationMirror createUnderInitializationAnnotation(TypeMirror typeFrame)

Creates a UnderInitialization annotation with the given type as its type frame argument.

Parameters:

typeFrame - the type down to which some value has been initialized

Returns:

an UnderInitialization annotation with the given argument

getSelfType

public @Nullable AnnotatedTypeMirror.AnnotatedDeclaredType getSelfType(Tree tree)

Description copied from class: AnnotatedTypeFactory

Returns the type of this at the location of tree. Returns null if tree is in a location where this has no meaning, such as the body of a static method.

The parameter is an arbitrary tree and does not have to mention "this", neither explicitly nor implicitly. This method can be overridden for type-system specific behavior.

Overrides:

getSelfType in class AnnotatedTypeFactory

Parameters:

tree - location used to decide the type of this

Returns:

the type of this at the location of tree

setSelfTypeInInitializationCode

protected void setSelfTypeInInitializationCode(Tree tree,
 AnnotatedTypeMirror.AnnotatedDeclaredType selfType,
 TreePath path)

Side-effects argument selfType to make it @Initialized or @UnderInitialization, depending on whether all fields have been set.

Parameters:

tree - a tree

selfType - the type to side-effect

path - a path

getUnderInitializationAnnotationOfSuperType

protected AnnotationMirror getUnderInitializationAnnotationOfSuperType(TypeMirror type)

Returns an UnderInitialization annotation that has the superclass of type as type frame.

Parameters:

type - a type

Returns:

true an UnderInitialization for the supertype of type

isUnused

protected boolean isUnused(VariableTree field,
 Collection<? extends AnnotationMirror> receiverAnnos)

Returns whether the specified field is unused, given the specified annotations on the receiver.

Parameters:

field - the field to check

receiverAnnos - the annotations on the receiver

Returns:

whether field is unused given receiverAnnos

createUnderInitializationAnnotation

public AnnotationMirror createUnderInitializationAnnotation(Class<?> typeFrame)

Creates a UnderInitialization annotation with the given type frame.

Parameters:

typeFrame - the type down to which some value has been initialized

Returns:

an UnderInitialization annotation with the given argument

areAllFieldsInitializedOnly

protected boolean areAllFieldsInitializedOnly(ClassTree classTree)

Are all fields initialized-only?

Parameters:

classTree - the class to query

Returns:

true if all fields are initialized-only

getUninitializedFields

public List<VariableTree> getUninitializedFields(InitializationStore store,
 TreePath path,
 boolean isStatic,
 Collection<? extends AnnotationMirror> receiverAnnotations)

Returns the fields that are possibly uninitialized in a given store, without taking into account the target checker.

I.e., this method returns all fields that have not been assigned, without considering fields that may be considered initialized by the target checker even though they have not been explicitly assigned. See InitializationAnnotatedTypeFactory.getUninitializedFields(InitializationStore, CFAbstractStore, TreePath, boolean, Collection) for a method that does take the target checker into account.

Parameters:

store - a store

path - the current path, used to determine the current class

isStatic - whether to report static fields or instance fields

receiverAnnotations - the annotations on the receiver

Returns:

the fields that are not yet initialized in a given store

getInitializedFields

public List<VariableTree> getInitializedFields(InitializationStore store,
 TreePath path)

Returns the fields that are initialized in the given store.

Parameters:

store - a store

path - the current path; used to compute the current class

Returns:

the fields that are initialized in the given store

isNotFullyInitializedReceiver

public boolean isNotFullyInitializedReceiver(MethodTree methodTree)

Description copied from class: GenericAnnotatedTypeFactory

Returns true if the receiver of a method or constructor might not be fully initialized.

Overrides:

isNotFullyInitializedReceiver in class GenericAnnotatedTypeFactory<CFValue,InitializationStore,InitializationTransfer,InitializationAnalysis>

Parameters:

methodTree - the declaration of the method or constructor

Returns:

true if the receiver of a method or constructor might not be fully initialized

createUnknownInitializationAnnotation

public AnnotationMirror createUnknownInitializationAnnotation(Class<?> typeFrame)

Creates a UnknownInitialization annotation with a given type frame.

Parameters:

typeFrame - the type down to which some value has been initialized

Returns:

an UnknownInitialization annotation with the given argument

createUnknownInitializationAnnotation

public AnnotationMirror createUnknownInitializationAnnotation(TypeMirror typeFrame)

Creates an UnknownInitialization annotation with a given type frame.

Parameters:

typeFrame - the type down to which some value has been initialized

Returns:

an UnknownInitialization annotation with the given argument

isUnderInitialization

public boolean isUnderInitialization(AnnotationMirror anno)

Is anno the UnderInitialization annotation (with any type frame)?

Parameters:

anno - the annotation to check

Returns:

true if anno is UnderInitialization

isUnknownInitialization

public boolean isUnknownInitialization(AnnotationMirror anno)

Is anno the UnknownInitialization annotation (with any type frame)?

Parameters:

anno - the annotation to check

Returns:

true if anno is UnknownInitialization

isFbcBottom

public boolean isFbcBottom(AnnotationMirror anno)

Is anno the bottom annotation?

Parameters:

anno - the annotation to check

Returns:

true if anno is FBCBottom

isInitialized

public boolean isInitialized(AnnotationMirror anno)

Is anno the Initialized annotation?

Parameters:

anno - the annotation to check

Returns:

true if anno is Initialized

isUnderInitialization

public boolean isUnderInitialization(AnnotatedTypeMirror anno)

Does anno have the annotation UnderInitialization (with any type frame)?

Parameters:

anno - the annotation to check

Returns:

true if anno has UnderInitialization

isUnknownInitialization

public boolean isUnknownInitialization(AnnotatedTypeMirror anno)

Does anno have the annotation UnknownInitialization (with any type frame)?

Parameters:

anno - the annotation to check

Returns:

true if anno has UnknownInitialization

isFbcBottom

public boolean isFbcBottom(AnnotatedTypeMirror anno)

Does anno have the bottom annotation?

Parameters:

anno - the annotation to check

Returns:

true if anno has FBCBottom

isInitialized

public boolean isInitialized(AnnotatedTypeMirror anno)

Does anno have the annotation Initialized?

Parameters:

anno - the annotation to check

Returns:

true if anno has Initialized

isInitializedForFrame

public boolean isInitializedForFrame(AnnotatedTypeMirror type,
 TypeMirror frame)

Return true if the type is initialized with respect to the given frame -- that is, all of the fields of the frame are initialized.

Parameters:

type - the type whose initialization type qualifiers to check

frame - a class in type's class hierarchy

Returns:

true if the type is initialized for the given frame

getTypeFrameFromAnnotation

public TypeMirror getTypeFrameFromAnnotation(AnnotationMirror annotation)

Returns the type frame (that is, the argument) of a given initialization annotation.

Parameters:

annotation - a UnderInitialization or UnknownInitialization annotation

Returns:

the annotation's argument

createQualifierHierarchy

protected QualifierHierarchy createQualifierHierarchy()

Description copied from class: AnnotatedTypeFactory

Returns the QualifierHierarchy to be used by this checker.

The implementation builds the type qualifier hierarchy for the AnnotatedTypeFactory.getSupportedTypeQualifiers() using the meta-annotations found in them. The current implementation returns an instance of NoElementQualifierHierarchy.

Subclasses must override this method if their qualifiers have elements; the method must return an implementation of QualifierHierarchy, such as ElementQualifierHierarchy.

Overrides:

createQualifierHierarchy in class AnnotatedTypeFactory

Returns:

a QualifierHierarchy for this type system

createTypeAnnotator

protected TypeAnnotator createTypeAnnotator()

Description copied from class: GenericAnnotatedTypeFactory

Returns a DefaultForTypeAnnotator that adds annotations to a type based on the content of the type itself.

Subclass may override this method. The default type annotator is a ListTypeAnnotator of the following:

1. IrrelevantTypeAnnotator: Adds top to types not listed in the @RelevantJavaTypes annotation on the checker.
2. PropagationTypeAnnotator: Propagates annotation onto wildcards.

Overrides:

createTypeAnnotator in class GenericAnnotatedTypeFactory<CFValue,InitializationStore,InitializationTransfer,InitializationAnalysis>

Returns:

a type annotator

shouldWarnIfStubRedundantWithBytecode

public boolean shouldWarnIfStubRedundantWithBytecode()

Returns false. Redundancy in only the initialization hierarchy is ok and may even be caused by implicit default annotations. The parent checker should determine whether to warn about redundancy.

Overrides:

shouldWarnIfStubRedundantWithBytecode in class AnnotatedTypeFactory

Returns:

whether to warn about redundancy between a stub file and bytecode

createTreeAnnotator

protected TreeAnnotator createTreeAnnotator()

Description copied from class: GenericAnnotatedTypeFactory

Returns a TreeAnnotator that adds annotations to a type based on the contents of a tree.

The default tree annotator is a ListTreeAnnotator of the following:

1. PropagationTreeAnnotator: Propagates annotations from subtrees
2. LiteralTreeAnnotator: Adds annotations based on QualifierForLiterals meta-annotations
3. DependentTypesTreeAnnotator: Adapts dependent annotations based on context

Subclasses may override this method to specify additional tree annotators, for example:

 new ListTreeAnnotator(super.createTreeAnnotator(), new KeyLookupTreeAnnotator(this));
 

Overrides:

createTreeAnnotator in class GenericAnnotatedTypeFactory<CFValue,InitializationStore,InitializationTransfer,InitializationAnalysis>

Returns:

a tree annotator

methodFromUse

protected AnnotatedTypeFactory.ParameterizedExecutableType methodFromUse(ExpressionTree tree,
 ExecutableElement methodElt,
 AnnotatedTypeMirror receiverType,
 boolean inferTypeArgs)

Description copied from class: AnnotatedTypeFactory

The implementation of AnnotatedTypeFactory.methodFromUse(ExpressionTree, ExecutableElement, AnnotatedTypeMirror) and AnnotatedTypeFactory.methodFromUseWithoutTypeArgInference(ExpressionTree, ExecutableElement, AnnotatedTypeMirror).

Overrides:

methodFromUse in class AnnotatedTypeFactory

Parameters:

tree - either a MethodInvocationTree or a MemberReferenceTree

methodElt - the element of the referenced method

receiverType - the type of the receiver

inferTypeArgs - whether type arguments should be inferred

Returns:

the type of the invoked method