HashChain

java.lang.Object
- java.util.AbstractCollection<E>
- - soot.util.HashChain<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, Chain<E>

Direct Known Subclasses:

IterableSet, PegChain
```
public class HashChain<E>
extends java.util.AbstractCollection<E>
implements Chain<E>
```
Reference implementation of the Chain interface, using a HashMap as the underlying structure.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class HashChain.Link<X extends E>

protected class HashChain.LinkIterator<X extends E>

Nested Classes
Modifier and Type	Class and Description
`protected class`	`HashChain.Link<X extends E>`
`protected class`	`HashChain.LinkIterator<X extends E>`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.util.Iterator<?>`	`emptyIterator`
`protected E`	`firstItem`
`protected E`	`lastItem`
`protected java.util.Map<E,HashChain.Link<E>>`	`map`
`protected int`	`stateCount`

Constructor Summary

Constructors
Constructor and Description

HashChain()
Constructs an empty HashChain.

HashChain(Chain<E> src)
Constructs a HashChain filled with the contents of the src Chain.

Constructors
Constructor and Description
`HashChain()` Constructs an empty HashChain.
`HashChain(Chain<E> src)` Constructs a HashChain filled with the contents of the src Chain.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(E item)` Adds the given object to this HashChain.
`void`	`addFirst(E item)` Adds the given object at the beginning of the Chain.
`void`	`addLast(E item)` Adds the given object at the end of the Chain.
`void`	`clear()` Erases the contents of the current HashChain.
`boolean`	`contains(java.lang.Object o)`
`boolean`	`containsAll(java.util.Collection<?> c)`
`boolean`	`follows(E someObject, E someReferenceObject)` Returns true if object `someObject` follows object `someReferenceObject` in the Chain.
`java.util.Collection<E>`	`getElementsUnsorted()` Gets all elements in the chain.
`E`	`getFirst()` Returns the first object in this Chain.
`E`	`getLast()` Returns the last object in this Chain.
`long`	`getModificationCount()` Returns the number of times this chain has been modified.
`E`	`getPredOf(E point)` Returns the object immediately preceding `point`.
`E`	`getSuccOf(E point)` Returns the object immediately following `point`.
`void`	`insertAfter(Chain<E> toInsert, E point)` Inserts `toInsert` in the Chain after `point`.
`void`	`insertAfter(java.util.Collection<? extends E> toInsert, E point)`
`void`	`insertAfter(E toInsert, E point)` Inserts `toInsert` in the Chain after `point`.
`void`	`insertAfter(java.util.List<E> toInsert, E point)` Inserts `toInsert` in the Chain after `point`.
`void`	`insertBefore(Chain<E> toInsert, E point)` Inserts `toInsert` in the Chain before `point`.
`void`	`insertBefore(java.util.Collection<? extends E> toInsert, E point)`
`void`	`insertBefore(E toInsert, E point)` Inserts `toInsert` in the Chain before `point`.
`void`	`insertBefore(java.util.List<E> toInsert, E point)` Inserts `toInsert` in the Chain before `point`.
`void`	`insertOnEdge(Chain<E> toInsert, E point_src, E point_tgt)` Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain `toInsert` on an edge that is defined by `point_source` and `point_target`.
`void`	`insertOnEdge(java.util.Collection<? extends E> toInsert, E point_src, E point_tgt)` Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain `toInsert` on an edge that is defined by `point_source` and `point_target`.
`void`	`insertOnEdge(E toInsert, E point_src, E point_tgt)` Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain `toInsert` on an edge that is defined by `point_source` and `point_target`.
`void`	`insertOnEdge(java.util.List<E> toInsert, E point_src, E point_tgt)` Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain `toInsert` on an edge that is defined by `point_source` and `point_target`.
`java.util.Iterator<E>`	`iterator()` Returns an iterator over this Chain.
`java.util.Iterator<E>`	`iterator(E item)` Returns an iterator over this Chain, starting at the given object.
`java.util.Iterator<E>`	`iterator(E head, E tail)` Returns an iterator ranging from `head` to `tail`, inclusive.
`static <T> HashChain<T>`	`listToHashChain(java.util.List<T> list)`
`boolean`	`remove(java.lang.Object item)` Removes the given object from this Chain.
`void`	`removeFirst()` Removes the first object contained in this Chain.
`void`	`removeLast()` Removes the last object contained in this Chain.
`int`	`size()` Returns the size of this Chain.
`java.util.Iterator<E>`	`snapshotIterator()` Returns an iterator over a copy of this chain.
`java.util.Iterator<E>`	`snapshotIterator(E item)`
`void`	`swapWith(E out, E in)` Replaces `out` in the Chain by `in`.
`static <E> java.util.List<E>`	`toList(Chain<E> c)` Deprecated. you can use `new ArrayList(c)` instead
`java.lang.String`	`toString()` Returns a textual representation of the contents of this Chain.

Methods inherited from class java.util.AbstractCollection
addAll, isEmpty, removeAll, retainAll, toArray, toArray

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

Methods inherited from interface java.util.Collection
addAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - map
```
protected java.util.Map<E,HashChain.Link<E>> map
```
  - firstItem
```
protected E firstItem
```
  - lastItem
```
protected E lastItem
```
  - stateCount
```
protected int stateCount
```
  - emptyIterator
```
protected static final java.util.Iterator<?> emptyIterator
```
- Constructor Detail
  - HashChain
```
public HashChain()
```
    Constructs an empty HashChain.
  - HashChain
```
public HashChain(Chain<E> src)
```
    Constructs a HashChain filled with the contents of the src Chain.
- Method Detail
  - clear
```
public void clear()
```
    Erases the contents of the current HashChain.
    
    Specified by:
    
    clear in interface java.util.Collection<E>
    
    Overrides:
    
    clear in class java.util.AbstractCollection<E>
  - swapWith
```
public void swapWith(E out,
                     E in)
```
    Description copied from interface: Chain
    
    Replaces out in the Chain by in.
    
    Specified by:
    
    swapWith in interface Chain<E>
  - add
```
public boolean add(E item)
```
    Adds the given object to this HashChain.
    
    Specified by:
    
    add in interface java.util.Collection<E>
    
    Overrides:
    
    add in class java.util.AbstractCollection<E>
  - getElementsUnsorted
```
public java.util.Collection<E> getElementsUnsorted()
```
    Gets all elements in the chain. There is no guarantee on sorting.
    
    Specified by:
    
    getElementsUnsorted in interface Chain<E>
    
    Returns:
    
    All elements in the chain in an unsorted collection
  - toList
```
@Deprecated
public static <E> java.util.List<E> toList(Chain<E> c)
```
    Deprecated. you can use new ArrayList(c) instead
    
    Returns an unbacked list containing the contents of the given Chain.
  - follows
```
public boolean follows(E someObject,
                       E someReferenceObject)
```
    Description copied from interface: Chain
    
    Returns true if object someObject follows object someReferenceObject in the Chain.
    
    Specified by:
    
    follows in interface Chain<E>
  - contains
```
public boolean contains(java.lang.Object o)
```
    Specified by:
    
    contains in interface java.util.Collection<E>
    
    Overrides:
    
    contains in class java.util.AbstractCollection<E>
  - containsAll
```
public boolean containsAll(java.util.Collection<?> c)
```
    Specified by:
    
    containsAll in interface java.util.Collection<E>
    
    Overrides:
    
    containsAll in class java.util.AbstractCollection<E>
  - insertAfter
```
public void insertAfter(E toInsert,
                        E point)
```
    Description copied from interface: Chain
    
    Inserts toInsert in the Chain after point.
    
    Specified by:
    
    insertAfter in interface Chain<E>
  - insertAfter
```
public void insertAfter(java.util.Collection<? extends E> toInsert,
                        E point)
```
  - insertAfter
```
public void insertAfter(java.util.List<E> toInsert,
                        E point)
```
    Description copied from interface: Chain
    
    Inserts toInsert in the Chain after point.
    
    Specified by:
    
    insertAfter in interface Chain<E>
  - insertAfter
```
public void insertAfter(Chain<E> toInsert,
                        E point)
```
    Description copied from interface: Chain
    
    Inserts toInsert in the Chain after point. (It would probably be better to make Chain implement List)
    
    Specified by:
    
    insertAfter in interface Chain<E>
  - insertBefore
```
public void insertBefore(E toInsert,
                         E point)
```
    Description copied from interface: Chain
    
    Inserts toInsert in the Chain before point.
    
    Specified by:
    
    insertBefore in interface Chain<E>
  - insertBefore
```
public void insertBefore(java.util.Collection<? extends E> toInsert,
                         E point)
```
  - insertBefore
```
public void insertBefore(java.util.List<E> toInsert,
                         E point)
```
    Description copied from interface: Chain
    
    Inserts toInsert in the Chain before point.
    
    Specified by:
    
    insertBefore in interface Chain<E>
  - insertBefore
```
public void insertBefore(Chain<E> toInsert,
                         E point)
```
    Description copied from interface: Chain
    
    Inserts toInsert in the Chain before point. (It would probably be better to make Chain implement List)
    
    Specified by:
    
    insertBefore in interface Chain<E>
  - insertOnEdge
```
public void insertOnEdge(E toInsert,
                         E point_src,
                         E point_tgt)
```
    Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain toInsert on an edge that is defined by point_source and point_target.
    
    Specified by:
    
    insertOnEdge in interface Chain<E>
    
    Parameters:
    
    toInsert - the instrumentation to be added in the Chain
    
    point_src - the source point of an edge in CFG
    
    point_tgt - the target point of an edge
  - insertOnEdge
```
public void insertOnEdge(java.util.Collection<? extends E> toInsert,
                         E point_src,
                         E point_tgt)
```
    Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain toInsert on an edge that is defined by point_source and point_target.
    
    Parameters:
    
    toInsert - instrumentation to be added in the Chain
    
    point_src - the source point of an edge in CFG
    
    point_tgt - the target point of an edge
  - insertOnEdge
```
public void insertOnEdge(java.util.List<E> toInsert,
                         E point_src,
                         E point_tgt)
```
    Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain toInsert on an edge that is defined by point_source and point_target.
    
    Specified by:
    
    insertOnEdge in interface Chain<E>
    
    Parameters:
    
    toInsert - instrumentation to be added in the Chain
    
    point_src - the source point of an edge in CFG
    
    point_tgt - the target point of an edge
  - insertOnEdge
```
public void insertOnEdge(Chain<E> toInsert,
                         E point_src,
                         E point_tgt)
```
    Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain toInsert on an edge that is defined by point_source and point_target.
    
    Specified by:
    
    insertOnEdge in interface Chain<E>
    
    Parameters:
    
    toInsert - instrumentation to be added in the Chain
    
    point_src - the source point of an edge in CFG
    
    point_tgt - the target point of an edge
  - listToHashChain
```
public static <T> HashChain<T> listToHashChain(java.util.List<T> list)
```
  - remove
```
public boolean remove(java.lang.Object item)
```
    Description copied from interface: Chain
    
    Removes the given object from this Chain. Parameter has to be of type Object to be compatible with the Collection interface.
    
    Specified by:
    
    remove in interface java.util.Collection<E>
    
    Specified by:
    
    remove in interface Chain<E>
    
    Overrides:
    
    remove in class java.util.AbstractCollection<E>
  - addFirst
```
public void addFirst(E item)
```
    Description copied from interface: Chain
    
    Adds the given object at the beginning of the Chain.
    
    Specified by:
    
    addFirst in interface Chain<E>
  - addLast
```
public void addLast(E item)
```
    Description copied from interface: Chain
    
    Adds the given object at the end of the Chain.
    
    Specified by:
    
    addLast in interface Chain<E>
  - removeFirst
```
public void removeFirst()
```
    Description copied from interface: Chain
    
    Removes the first object contained in this Chain.
    
    Specified by:
    
    removeFirst in interface Chain<E>
  - removeLast
```
public void removeLast()
```
    Description copied from interface: Chain
    
    Removes the last object contained in this Chain.
    
    Specified by:
    
    removeLast in interface Chain<E>
  - getFirst
```
public E getFirst()
```
    Description copied from interface: Chain
    
    Returns the first object in this Chain.
    
    Specified by:
    
    getFirst in interface Chain<E>
  - getLast
```
public E getLast()
```
    Description copied from interface: Chain
    
    Returns the last object in this Chain.
    
    Specified by:
    
    getLast in interface Chain<E>
  - getSuccOf
```
public E getSuccOf(E point)
            throws java.util.NoSuchElementException
```
    Description copied from interface: Chain
    
    Returns the object immediately following point.
    
    Specified by:
    
    getSuccOf in interface Chain<E>
    
    Throws:
    
    java.util.NoSuchElementException
  - getPredOf
```
public E getPredOf(E point)
            throws java.util.NoSuchElementException
```
    Description copied from interface: Chain
    
    Returns the object immediately preceding point.
    
    Specified by:
    
    getPredOf in interface Chain<E>
    
    Throws:
    
    java.util.NoSuchElementException
  - snapshotIterator
```
public java.util.Iterator<E> snapshotIterator()
```
    Description copied from interface: Chain
    
    Returns an iterator over a copy of this chain. This avoids ConcurrentModificationExceptions from being thrown if the underlying Chain is modified during iteration. Do not use this to remove elements which have not yet been iterated over!
    
    Specified by:
    
    snapshotIterator in interface Chain<E>
  - snapshotIterator
```
public java.util.Iterator<E> snapshotIterator(E item)
```
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Description copied from interface: Chain
    
    Returns an iterator over this Chain.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in interface Chain<E>
    
    Specified by:
    
    iterator in class java.util.AbstractCollection<E>
  - iterator
```
public java.util.Iterator<E> iterator(E item)
```
    Description copied from interface: Chain
    
    Returns an iterator over this Chain, starting at the given object.
    
    Specified by:
    
    iterator in interface Chain<E>
  - iterator
```
public java.util.Iterator<E> iterator(E head,
                                      E tail)
```
    Returns an iterator ranging from head to tail, inclusive.
    
    If tail is the element immediately preceding head in this HashChain, the returned iterator will iterate 0 times (a special case to allow the specification of an empty range of elements). Otherwise if tail is not one of the elements following head, the returned iterator will iterate past the end of the HashChain, provoking a NoSuchElementException.
    
    Specified by:
    
    iterator in interface Chain<E>
    
    Throws:
    
    java.util.NoSuchElementException - if head is not an element of the chain.
  - size
```
public int size()
```
    Description copied from interface: Chain
    
    Returns the size of this Chain.
    
    Specified by:
    
    size in interface java.util.Collection<E>
    
    Specified by:
    
    size in interface Chain<E>
    
    Specified by:
    
    size in class java.util.AbstractCollection<E>
  - toString
```
public java.lang.String toString()
```
    Returns a textual representation of the contents of this Chain.
    
    Overrides:
    
    toString in class java.util.AbstractCollection<E>
  - getModificationCount
```
public long getModificationCount()
```
    Returns the number of times this chain has been modified.
    
    Specified by:
    
    getModificationCount in interface Chain<E>

Class HashChain<E>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

map

firstItem

lastItem

stateCount

emptyIterator

Constructor Detail

HashChain

HashChain

Method Detail

clear

swapWith

add

getElementsUnsorted

toList

follows

contains

containsAll

insertAfter

insertAfter

insertAfter

insertAfter

insertBefore

insertBefore

insertBefore

insertBefore

insertOnEdge

insertOnEdge

insertOnEdge

insertOnEdge

listToHashChain

remove

addFirst

addLast

removeFirst

removeLast

getFirst

getLast

getSuccOf

getPredOf

snapshotIterator

snapshotIterator

iterator

iterator

iterator

size

toString

getModificationCount