Package soot.util

Class UnitMap<T>

java.lang.Object

soot.util.UnitMap<T>

All Implemented Interfaces:

Map<Unit,T>

public abstract class UnitMap<T>
extends Object
implements Map<Unit,T>

Maps each unit to the result of mapTo.

Nested Class Summary

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

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	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 map 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 map 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 map 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 map 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 map 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 map is initialized to initialCapacity and loadFactor.

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<Unit,T>>	entrySet()
boolean	equals(Object o)
T	get(Object key)
int	hashCode()
protected void	init()	allows one-time initialization before any mapping.
boolean	isEmpty()
Set<Unit>	keySet()
protected abstract T	mapTo(Unit unit)	maps a unit to an object.
T	put(Unit key, T value)
void	putAll(Map<? extends Unit,? extends T> t)
T	remove(Object key)
int	size()
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 map 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 map 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 map is initialized to initialCapacity.

Parameters:

b - a Body

initialCapacity - the initialCapacity of the internal map.

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 map is initialized to initialCapacity.

Parameters:

g - a UnitGraph

initialCapacity - the initialCapacity of the internal map.

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 map is initialized to initialCapacity and loadFactor.

Parameters:

b - a Body

initialCapacity - the initialCapacity of the internal map.

loadFactor - the loadFactor of the internal map.

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 map is initialized to initialCapacity and loadFactor.

Parameters:

g - a UnitGraph

initialCapacity - the initialCapacity of the internal map.

loadFactor - the loadFactor of the internal map.

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:

unit - 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 Map<Unit,T>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<Unit,T>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<Unit,T>

entrySet

public Set<Map.Entry<Unit,T>> entrySet()

Specified by:

entrySet in interface Map<Unit,T>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<Unit,T>

Overrides:

equals in class Object

get

public T get(Object key)

Specified by:

get in interface Map<Unit,T>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<Unit,T>

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Unit,T>

keySet

public Set<Unit> keySet()

Specified by:

keySet in interface Map<Unit,T>

put

public T put(Unit key,
             T value)

Specified by:

put in interface Map<Unit,T>

putAll

public void putAll(Map<? extends Unit,? extends T> t)

Specified by:

putAll in interface Map<Unit,T>

remove

public T remove(Object key)

Specified by:

remove in interface Map<Unit,T>

size

public int size()

Specified by:

size in interface Map<Unit,T>

values

public Collection<T> values()

Specified by:

values in interface Map<Unit,T>