Interface Store<S extends Store<S>>
 Type Parameters:
S
 the type of the store returned bycopy
and that is used inleastUpperBound
. Usually it is the implementing class itself, e.g. inT extends Store<T>
.
 All Known Implementing Classes:
AccumulationStore
,BusyExprStore
,CFAbstractStore
,CFStore
,ConstantPropagationStore
,InitializationStore
,KeyForStore
,LiveVarStore
,LockStore
,NullnessStore
,ReachingDefinitionStore
public interface Store<S extends Store<S>>
A store is used to keep track of the information that the org.checkerframework.dataflow analysis
has accumulated at any given point in time.

Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic enum
A flow rule describes how stores flow along one edge between basic blocks.static enum

Method Summary
Modifier and TypeMethodDescriptionboolean
Can the objectsa
andb
be aliases? Returns a conservative answer (i.e., returnstrue
if not enough information is available to determine aliasing).copy()
Returns an exact copy of this store.boolean
Returns true if this is equal to the given argument.leastUpperBound
(S other) Compute the least upper bound of two stores.visualize
(CFGVisualizer<?, S, ?> viz) Delegate visualization responsibility to a visualizer.widenedUpperBound
(S previous) Compute an upper bound of two stores that is wider than the least upper bound of the two stores.

Method Details

copy
S copy()Returns an exact copy of this store. Returns:
 an exact copy of this store

leastUpperBound
Compute the least upper bound of two stores.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.
 Does not change

widenedUpperBound
Compute an upper bound of two stores that is wider than the least upper bound of the two stores. Used to jump to a higher abstraction to allow faster termination of the fixed point computations inAnalysis
.previous
must be the previous store.A particular analysis might not require widening and should implement this method by calling leastUpperBound.
Important: This method must fulfill the following contract:
 Does not change
this
.  Does not change
previous
.  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.
 Parameters:
previous
 must be the previous store
 Does not change

canAlias
Can the objectsa
andb
be aliases? Returns a conservative answer (i.e., returnstrue
if not enough information is available to determine aliasing). 
visualize
Delegate visualization responsibility to a visualizer. Parameters:
viz
 the visualizer to visualize this store Returns:
 the String representation of this store

equals
Returns true if this is equal to the given argument.
