DavaFlowSet (Soot - a J*va Optimization Framework 4.1.0 API)

java.lang.Object
- soot.toolkits.scalar.AbstractFlowSet<T>
- - soot.dava.toolkits.base.AST.structuredAnalysis.DavaFlowSet<T>

All Implemented Interfaces:

Iterable<T>, FlowSet<T>

Direct Known Subclasses:

CPFlowSet, UnreachableCodeFinder.UnreachableCodeFlowSet
```
public class DavaFlowSet<T>
extends AbstractFlowSet<T>
```

Field Summary

Fields
Modifier and Type Field and Description

protected T[] elements

Fields
Modifier and Type	Field and Description
`protected T[]`	`elements`

Constructor Summary

Constructors
Constructor and Description

DavaFlowSet()

DavaFlowSet(DavaFlowSet<T> other)

Constructors
Constructor and Description
`DavaFlowSet()`
`DavaFlowSet(DavaFlowSet<T> other)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(T e)` Adds `obj` to `this`.
`void`	`addToBreakList(String labelBroken, DavaFlowSet<T> set)` When an explicit break statement is encountered this method should be called to store the current davaflowset
`void`	`addToContinueList(String labelContinued, DavaFlowSet<T> set)` When an explicit continue statement is encountered this method should be called to store the current davaflowset
`void`	`addToImplicitBreaks(DAbruptStmt ab, DavaFlowSet<T> set)` The next two methods take an abruptStmt as input along with a flowSet.
`void`	`addToImplicitContinues(DAbruptStmt ab, DavaFlowSet<T> set)`
`void`	`clear()` implemented, but very inefficient.
`DavaFlowSet<T>`	`clone()` Clones the current FlowSet.
`boolean`	`contains(Object obj)` Returns true if this FlowSet contains `obj`.
`void`	`copy(FlowSet<T> destFlow)` Copies the current FlowSet into dest.
`void`	`copyInternalDataFrom(DavaFlowSet<T> fromThis)`
`void`	`difference(FlowSet<T> otherFlow, FlowSet<T> destFlow)` Returns the set difference (this intersect ~other) of this FlowSet and `other`, putting result into `dest`.
`FlowSet<T>`	`emptySet()` implemented, but inefficient.
`boolean`	`equals(Object otherFlow)` Notice that the equals method only checks the equality of the elements of the flow set DavaFlowSet also contains information regarding abrupt control flow This should also be checked by invoking the internalDataMatchesTo method
`List<DavaFlowSet<T>>`	`getBreakSet(String label)`
`List<DavaFlowSet<T>>`	`getContinueSet(String label)`
`T`	`getElementAt(int idx)`
`int`	`getElementCount()`
`HashMap<Serializable,List<DavaFlowSet<T>>>`	`getImplicitBreaks()`
`HashMap<Serializable,List<DavaFlowSet<T>>>`	`getImplicitContinues()`
`List<DavaFlowSet<T>>`	`getImplicitlyBrokenSets(ASTNode node)`
`List<DavaFlowSet<T>>`	`getImplicitlyContinuedSets(ASTNode node)`
`boolean`	`internalDataMatchesTo(Object otherObj)`
`void`	`intersection(FlowSet<T> otherFlow, FlowSet<T> destFlow)` Notice that the intersection method only merges the elements of the flow set DavaFlowSet also contains information regarding abrupt control flow This should also be merged using the copyInternalDataFrom method
`boolean`	`isEmpty()` Returns true if this FlowSet is the empty set.
`Iterator<T>`	`iterator()` returns an iterator over the elements of the flowSet.
`void`	`remove(int idx)`
`void`	`remove(Object obj)` Removes `obj` from `this`.
`int`	`size()` Returns the size of the current FlowSet.
`List<T>`	`toList()` Returns a unbacked list of elements in this set.
`String`	`toString()`
`void`	`union(FlowSet<T> otherFlow, FlowSet<T> destFlow)` Notice that the union method only merges the elements of the flow set DavaFlowSet also contains information regarding abrupt control flow This should also be merged using the copyInternalDataFrom method

Methods inherited from class soot.toolkits.scalar.AbstractFlowSet
add, difference, hashCode, intersection, isSubSet, remove, union

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - elements
```
protected T[] elements
```
- Constructor Detail
  - DavaFlowSet
```
public DavaFlowSet()
```
  - DavaFlowSet
```
public DavaFlowSet(DavaFlowSet<T> other)
```
- Method Detail
  - clone
```
public DavaFlowSet<T> clone()
```
    Description copied from interface: FlowSet
    
    Clones the current FlowSet.
    
    Specified by:
    
    clone in interface FlowSet<T>
    
    Specified by:
    
    clone in class AbstractFlowSet<T>
  - emptySet
```
public FlowSet<T> emptySet()
```
    Description copied from class: AbstractFlowSet
    
    implemented, but inefficient.
    
    Specified by:
    
    emptySet in interface FlowSet<T>
    
    Overrides:
    
    emptySet in class AbstractFlowSet<T>
  - clear
```
public void clear()
```
    Description copied from class: AbstractFlowSet
    
    implemented, but *very* inefficient.
    
    Specified by:
    
    clear in interface FlowSet<T>
    
    Overrides:
    
    clear in class AbstractFlowSet<T>
  - size
```
public int size()
```
    Description copied from interface: FlowSet
    
    Returns the size of the current FlowSet.
    
    Specified by:
    
    size in interface FlowSet<T>
    
    Specified by:
    
    size in class AbstractFlowSet<T>
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: FlowSet
    
    Returns true if this FlowSet is the empty set.
    
    Specified by:
    
    isEmpty in interface FlowSet<T>
    
    Specified by:
    
    isEmpty in class AbstractFlowSet<T>
  - toList
```
public List<T> toList()
```
    Returns a unbacked list of elements in this set.
    
    Specified by:
    
    toList in interface FlowSet<T>
    
    Specified by:
    
    toList in class AbstractFlowSet<T>
  - add
```
public void add(T e)
```
    Description copied from interface: FlowSet
    
    Adds obj to this.
    
    Specified by:
    
    add in interface FlowSet<T>
    
    Specified by:
    
    add in class AbstractFlowSet<T>
  - remove
```
public void remove(Object obj)
```
    Description copied from interface: FlowSet
    
    Removes obj from this.
    
    Specified by:
    
    remove in interface FlowSet<T>
    
    Specified by:
    
    remove in class AbstractFlowSet<T>
  - remove
```
public void remove(int idx)
```
  - union
```
public void union(FlowSet<T> otherFlow,
                  FlowSet<T> destFlow)
```
    Notice that the union method only merges the elements of the flow set DavaFlowSet also contains information regarding abrupt control flow This should also be merged using the copyInternalDataFrom method
    
    Specified by:
    
    union in interface FlowSet<T>
    
    Overrides:
    
    union in class AbstractFlowSet<T>
  - intersection
```
public void intersection(FlowSet<T> otherFlow,
                         FlowSet<T> destFlow)
```
    Notice that the intersection method only merges the elements of the flow set DavaFlowSet also contains information regarding abrupt control flow This should also be merged using the copyInternalDataFrom method
    
    Specified by:
    
    intersection in interface FlowSet<T>
    
    Overrides:
    
    intersection in class AbstractFlowSet<T>
  - difference
```
public void difference(FlowSet<T> otherFlow,
                       FlowSet<T> destFlow)
```
    Description copied from interface: FlowSet
    
    Returns the set difference (this intersect ~other) of this FlowSet and other, putting result into dest. dest, other and this could be the same object.
    
    Specified by:
    
    difference in interface FlowSet<T>
    
    Overrides:
    
    difference in class AbstractFlowSet<T>
  - contains
```
public boolean contains(Object obj)
```
    Description copied from interface: FlowSet
    
    Returns true if this FlowSet contains obj.
    
    Specified by:
    
    contains in interface FlowSet<T>
    
    Specified by:
    
    contains in class AbstractFlowSet<T>
  - equals
```
public boolean equals(Object otherFlow)
```
    Notice that the equals method only checks the equality of the elements of the flow set DavaFlowSet also contains information regarding abrupt control flow This should also be checked by invoking the internalDataMatchesTo method
    
    Overrides:
    
    equals in class AbstractFlowSet<T>
  - copy
```
public void copy(FlowSet<T> destFlow)
```
    Description copied from interface: FlowSet
    
    Copies the current FlowSet into dest.
    
    Specified by:
    
    copy in interface FlowSet<T>
    
    Overrides:
    
    copy in class AbstractFlowSet<T>
  - addToBreakList
```
public void addToBreakList(String labelBroken,
                           DavaFlowSet<T> set)
```
    When an explicit break statement is encountered this method should be called to store the current davaflowset
  - addToContinueList
```
public void addToContinueList(String labelContinued,
                              DavaFlowSet<T> set)
```
    When an explicit continue statement is encountered this method should be called to store the current davaflowset
  - addToImplicitBreaks
```
public void addToImplicitBreaks(DAbruptStmt ab,
                                DavaFlowSet<T> set)
```
    The next two methods take an abruptStmt as input along with a flowSet. It should be only invoked for abrupt stmts which do not have explicit labels The node being targeted by this implicit stmt should be found Then the flow set should be added to the list within the appropriate hashmap
  - addToImplicitContinues
```
public void addToImplicitContinues(DAbruptStmt ab,
                                   DavaFlowSet<T> set)
```
  - getImplicitBreaks
```
public HashMap<Serializable,List<DavaFlowSet<T>>> getImplicitBreaks()
```
  - getImplicitContinues
```
public HashMap<Serializable,List<DavaFlowSet<T>>> getImplicitContinues()
```
  - getImplicitlyBrokenSets
```
public List<DavaFlowSet<T>> getImplicitlyBrokenSets(ASTNode node)
```
  - getImplicitlyContinuedSets
```
public List<DavaFlowSet<T>> getImplicitlyContinuedSets(ASTNode node)
```
  - copyInternalDataFrom
```
public void copyInternalDataFrom(DavaFlowSet<T> fromThis)
```
  - internalDataMatchesTo
```
public boolean internalDataMatchesTo(Object otherObj)
```
  - getContinueSet
```
public List<DavaFlowSet<T>> getContinueSet(String label)
```
  - getBreakSet
```
public List<DavaFlowSet<T>> getBreakSet(String label)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractFlowSet<T>
  - iterator
```
public Iterator<T> iterator()
```
    Description copied from interface: FlowSet
    
    returns an iterator over the elements of the flowSet. Note that the iterator might be backed, and hence be faster in the creation, than doing toList().iterator().
    
    Specified by:
    
    iterator in interface Iterable<T>
    
    Specified by:
    
    iterator in interface FlowSet<T>
    
    Specified by:
    
    iterator in class AbstractFlowSet<T>
  - getElementCount
```
public int getElementCount()
```
  - getElementAt
```
public T getElementAt(int idx)
```

Class DavaFlowSet<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class soot.toolkits.scalar.AbstractFlowSet

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

elements

Constructor Detail

DavaFlowSet

DavaFlowSet

Method Detail

clone

emptySet

clear

size

isEmpty

toList

add

remove

remove

union

intersection

difference

contains

equals

copy

addToBreakList

addToContinueList

addToImplicitBreaks

addToImplicitContinues

getImplicitBreaks

getImplicitContinues

getImplicitlyBrokenSets

getImplicitlyContinuedSets

copyInternalDataFrom

internalDataMatchesTo

getContinueSet

getBreakSet

toString

iterator

getElementCount

getElementAt