UnitMap

java.lang.Object
- soot.util.UnitMap<T>

All Implemented Interfaces:: java.util.Map<Unit,T>

public abstract class UnitMap<T>
extends java.lang.Object
implements java.util.Map<Unit,T>

Maps each unit to the result of mapTo.

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description
`UnitMap(Body b)` maps each unit of this body to the result of `mapTo`. before the mapping the method `init` is called. the internal hashtable is initialized without any parameter.
`UnitMap(Body b, int initialCapacity)` maps each unit of this body to the result of `mapTo`. before the mapping the method `init` is called. the internal hashtable is initialized to `initialCapacity`.
`UnitMap(Body b, int initialCapacity, float loadFactor)` maps each unit of this body to the result of `mapTo`. before the mapping the method `init` is called. the internal hashtable is initialized to `initialCapacity` and `loadFactor`.
`UnitMap(UnitGraph g)` maps each unit of the graph to the result of `mapTo`. before the mapping the method `init` is called. the internal hashtable is initialized without any parameter.
`UnitMap(UnitGraph g, int initialCapacity)` maps each unit of the graph to the result of `mapTo`. before the mapping the method `init` is called. the internal hashtable is initialized to `initialCapacity`.
`UnitMap(UnitGraph g, int initialCapacity, float loadFactor)` maps each unit of the graph to the result of `mapTo`. before the mapping the method `init` is called. the internal hashtable is initialized to `initialCapacity` and `loadFactor`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set<java.util.Map.Entry<Unit,T>>`	`entrySet()`
`boolean`	`equals(java.lang.Object o)`
`T`	`get(java.lang.Object key)`
`int`	`hashCode()`
`protected void`	`init()` allows one-time initialization before any mapping.
`boolean`	`isEmpty()`
`java.util.Set<Unit>`	`keySet()`
`protected abstract T`	`mapTo(Unit unit)` maps a unit to an object.
`T`	`put(Unit key, T value)`
`void`	`putAll(java.util.Map<? extends Unit,? extends T> t)`
`T`	`remove(java.lang.Object key)`
`int`	`size()`
`java.util.Collection<T>`	`values()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - UnitMap
```
public UnitMap(Body b)
```
    maps each unit of this body to the result of mapTo.
    before the mapping the method init is called.
    the internal hashtable is initialized without any parameter.
    
    Parameters:
    
    b - a Body
  - UnitMap
```
public UnitMap(UnitGraph g)
```
    maps each unit of the graph to the result of mapTo.
    before the mapping the method init is called.
    the internal hashtable is initialized without any parameter.
    
    Parameters:
    
    g - a UnitGraph
  - UnitMap
```
public UnitMap(Body b,
               int initialCapacity)
```
    maps each unit of this body to the result of mapTo.
    before the mapping the method init is called.
    the internal hashtable is initialized to initialCapacity.
    
    Parameters:
    
    b - a Body
    
    initialCapacity - the initialCapacity of the internal hashtable.
  - UnitMap
```
public UnitMap(UnitGraph g,
               int initialCapacity)
```
    maps each unit of the graph to the result of mapTo.
    before the mapping the method init is called.
    the internal hashtable is initialized to initialCapacity.
    
    Parameters:
    
    g - a UnitGraph
    
    initialCapacity - the initialCapacity of the internal hashtable.
  - UnitMap
```
public UnitMap(Body b,
               int initialCapacity,
               float loadFactor)
```
    maps each unit of this body to the result of mapTo.
    before the mapping the method init is called.
    the internal hashtable is initialized to initialCapacity and loadFactor.
    
    Parameters:
    
    b - a Body
    
    initialCapacity - the initialCapacity of the internal hashtable.
    
    loadFactor - the loadFactor of the internal hashtable.
  - UnitMap
```
public UnitMap(UnitGraph g,
               int initialCapacity,
               float loadFactor)
```
    maps each unit of the graph to the result of mapTo.
    before the mapping the method init is called.
    the internal hashtable is initialized to initialCapacity and loadFactor.
    
    Parameters:
    
    g - a UnitGraph
    
    initialCapacity - the initialCapacity of the internal hashtable.
    
    loadFactor - the loadFactor of the internal hashtable.
- Method Detail
  - init
```
protected void init()
```
    allows one-time initialization before any mapping. This method is called before any mapping of a unit (but only once in the beginning).
    If not overwritten does nothing.
  - mapTo
```
protected abstract T mapTo(Unit unit)
```
    maps a unit to an object. This method is called for every unit. If the returned object is null no object will be mapped.
    
    Parameters:
    
    the - Unit to which o should be mapped.
    
    Returns:
    
    an object that is mapped to the unit, or null.
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<Unit,T>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<Unit,T>
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<Unit,T>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<Unit,T>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<Unit,T>
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in interface java.util.Map<Unit,T>
    
    Overrides:
    
    equals in class java.lang.Object
  - get
```
public T get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<Unit,T>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map<Unit,T>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<Unit,T>
  - keySet
```
public java.util.Set<Unit> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<Unit,T>
  - put
```
public T put(Unit key,
             T value)
```
    Specified by:
    
    put in interface java.util.Map<Unit,T>
  - putAll
```
public void putAll(java.util.Map<? extends Unit,? extends T> t)
```
    Specified by:
    
    putAll in interface java.util.Map<Unit,T>
  - remove
```
public T remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<Unit,T>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<Unit,T>
  - values
```
public java.util.Collection<T> values()
```
    Specified by:
    
    values in interface java.util.Map<Unit,T>

Class UnitMap<T>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

UnitMap

UnitMap

UnitMap

UnitMap

UnitMap

UnitMap

Method Detail

init

mapTo

clear

containsKey

containsValue

entrySet

equals

get

hashCode

isEmpty

keySet

put

putAll

remove

size

values