HeapModel (API Reference for wala 1.3.9)

All Superinterfaces:

InstanceKeyFactory, PointerKeyFactory

All Known Subinterfaces:

AstHeapModel, ExtendedHeapModel

All Known Implementing Classes:

AstSSAPropagationCallGraphBuilder, CrossLanguageSSAPropagationCallGraphBuilder, DelegatingExtendedHeapModel, DexSSAPropagationCallGraphBuilder, nCFABuilder, PointerAnalysisImpl.HModel, SSAPropagationCallGraphBuilder, TypeBasedHeapModel, ZeroXCFABuilder, ZeroXContainerCFABuilder
```
public interface HeapModel
extends InstanceKeyFactory, PointerKeyFactory
```
A HeapModel embodies how a pointer analysis abstracts heap locations.

- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  IClassHierarchy getClassHierarchy()
  
  Iterator<PointerKey> iteratePointerKeys()
  - Methods inherited from interface com.ibm.wala.ipa.callgraph.propagation.InstanceKeyFactory
    getInstanceKeyForAllocation, getInstanceKeyForConstant, getInstanceKeyForMetadataObject, getInstanceKeyForMultiNewArray, getInstanceKeyForPEI
  - Methods inherited from interface com.ibm.wala.ipa.callgraph.propagation.PointerKeyFactory
    getFilteredPointerKeyForLocal, getPointerKeyForArrayContents, getPointerKeyForExceptionalReturnValue, getPointerKeyForInstanceField, getPointerKeyForLocal, getPointerKeyForReturnValue, getPointerKeyForStaticField

- Method Detail
  - iteratePointerKeys
```
Iterator<PointerKey> iteratePointerKeys()
```
    Returns:
    
    an Iterator of all PointerKeys that are modeled.
  - getClassHierarchy
```
IClassHierarchy getClassHierarchy()
```
    Returns:
    
    the governing class hierarchy for this heap model