Package org.checkerframework.common.accumulation

Class AccumulationAnalysis

java.lang.Object

org.checkerframework.dataflow.analysis.AbstractAnalysis<V,S,T>

org.checkerframework.dataflow.analysis.ForwardAnalysisImpl<V,S,T>

org.checkerframework.framework.flow.CFAbstractAnalysis<AccumulationValue,AccumulationStore,AccumulationTransfer>

org.checkerframework.common.accumulation.AccumulationAnalysis

All Implemented Interfaces:

Analysis<AccumulationValue,AccumulationStore,AccumulationTransfer>, ForwardAnalysis<AccumulationValue,AccumulationStore,AccumulationTransfer>

Direct Known Subclasses:

CalledMethodsAnalysis

public class AccumulationAnalysis
extends CFAbstractAnalysis<AccumulationValue,AccumulationStore,AccumulationTransfer>

This class only contains boilerplate code to permit AccumulationValue's accumulatedValues functionality to interact with the rest of an accumulation type system.

Nested Class Summary

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

CFAbstractAnalysis.FieldInitialValue<V extends CFAbstractValue<V>>

Nested classes/interfaces inherited from class org.checkerframework.dataflow.analysis.AbstractAnalysis

AbstractAnalysis.Worklist

Nested classes/interfaces inherited from interface org.checkerframework.dataflow.analysis.Analysis

Analysis.BeforeOrAfter, Analysis.Direction

Field Summary

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

atypeFactory, checker, dependentTypesHelper, env, fieldValues, qualHierarchy, typeHierarchy, types

Fields inherited from class org.checkerframework.dataflow.analysis.ForwardAnalysisImpl

blockCount, elseStores, maxCountBeforeWidening, storesAtReturnStatements, thenStores

Fields inherited from class org.checkerframework.dataflow.analysis.AbstractAnalysis

cfg, currentInput, currentNode, currentTree, direction, finalLocalValues, inputs, isRunning, nodeValues, transferFunction, worklist

Constructor Summary

Constructors

Constructor	Description
AccumulationAnalysis(BaseTypeChecker checker, AccumulationAnnotatedTypeFactory factory)	Constructs an AccumulationAnalysis.

Method Summary

Modifier and Type	Method	Description
@Nullable AccumulationValue	createAbstractValue(AnnotationMirrorSet annotations, javax.lang.model.type.TypeMirror underlyingType)	Returns an abstract value containing the given annotations and underlyingType.
AccumulationStore	createCopiedStore(AccumulationStore accumulationStore)	Returns an identical copy of the store s.
AccumulationStore	createEmptyStore(boolean sequentialSemantics)	Returns an empty store of the appropriate type.

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

createAbstractValue, createSingleAnnotationValue, createTransferFunction, defaultCreateAbstractValue, getEnv, getFieldInitialValues, getTypeFactory, getTypeHierarchy, getTypes, performAnalysis

Methods inherited from class org.checkerframework.dataflow.analysis.ForwardAnalysisImpl

addStoreBefore, callTransferFunction, getInput, getInputBefore, getReturnStatementStores, getStoreBefore, initFields, initInitialInputs, performAnalysis, performAnalysisBlock, propagateStoresTo, runAnalysisFor

Methods inherited from class org.checkerframework.dataflow.analysis.AbstractAnalysis

addToWorklist, getContainingClass, getContainingMethod, getCurrentTree, getDirection, getExceptionalExitStore, getNodesForTree, getNodeValues, getRegularExitStore, getResult, getTransferFunction, getValue, getValue, init, isIgnoredExceptionType, isRunning, readFromStore, setCurrentNode, setCurrentTree, updateNodeValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.checkerframework.dataflow.analysis.Analysis

getDirection, getExceptionalExitStore, getRegularExitStore, getResult, getTransferFunction, getValue, getValue, isRunning

Constructor Detail

AccumulationAnalysis

public AccumulationAnalysis(BaseTypeChecker checker,
                            AccumulationAnnotatedTypeFactory factory)

Constructs an AccumulationAnalysis.

Parameters:

checker - the checker

factory - the type factory

Method Detail

createEmptyStore

public AccumulationStore createEmptyStore(boolean sequentialSemantics)

Description copied from class: CFAbstractAnalysis

Returns an empty store of the appropriate type.

Specified by:

createEmptyStore in class CFAbstractAnalysis<AccumulationValue,AccumulationStore,AccumulationTransfer>

Returns:

an empty store of the appropriate type

createCopiedStore

public AccumulationStore createCopiedStore(AccumulationStore accumulationStore)

Description copied from class: CFAbstractAnalysis

Returns an identical copy of the store s.

Specified by:

createCopiedStore in class CFAbstractAnalysis<AccumulationValue,AccumulationStore,AccumulationTransfer>

Returns:

an identical copy of the store s

createAbstractValue

public @Nullable AccumulationValue createAbstractValue(AnnotationMirrorSet annotations,
                                                       javax.lang.model.type.TypeMirror underlyingType)

Description copied from class: CFAbstractAnalysis

Returns an abstract value containing the given annotations and underlyingType. Returns null if the annotation set has missing annotations.

Specified by:

createAbstractValue in class CFAbstractAnalysis<AccumulationValue,AccumulationStore,AccumulationTransfer>

Parameters:

annotations - the annotations for the result annotated type

underlyingType - the unannotated type for the result annotated type

Returns:

an abstract value containing the given annotations and underlyingType