DominatorTree (Soot 2.5.0-7 API)

java.lang.Object
- soot.toolkits.graph.DominatorTree

Direct Known Subclasses:

MHGDominatorTree
```
public class DominatorTree
extends java.lang.Object
```
Constructs a dominator tree structure from the given DominatorsFinder. The nodes in DominatorTree are of type DominatorNode.
Note: DominatorTree does not currently implement DirectedGraph since it provides 4 methods of navigating the nodes where the meaning of getPredsOf and getSuccsOf diverge from the usual meaning in a DirectedGraph implementation.
If you need a DirectedGraph implementation, see DominatorTreeAdapter.

Author:

Navindra Umanee

Field Summary

Fields
Modifier and Type	Field and Description
`protected DominatorsFinder`	`dominators`
`protected java.util.HashMap`	`godeToDode` "gode" is a node in the original graph, "dode" is a node in the dominator tree.
`protected DirectedGraph`	`graph`
`protected DominatorNode`	`head`
`protected java.util.ArrayList`	`tails`

Constructor Summary

Constructors
Constructor and Description

DominatorTree(DominatorsFinder dominators)

Constructors
Constructor and Description
`DominatorTree(DominatorsFinder dominators)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`buildTree()` Add all the necessary links between nodes to form a meaningful tree structure.
`protected DominatorNode`	`fetchDode(java.lang.Object gode)` Convenience method, ensures we don't create more than one DominatorNode for a given block.
`protected DominatorNode`	`fetchParent(java.lang.Object gode)`
`java.util.List`	`getChildrenOf(DominatorNode node)` Returns the children of node in the tree.
`DominatorNode`	`getDode(java.lang.Object gode)` Returns the DominatorNode for a given node in the original DirectedGraph.
`DirectedGraph`	`getGraph()` Returns the original graph to which the Dominator tree pertains.
`DominatorNode`	`getHead()` Returns the root of the dominator tree.
`DominatorNode`	`getParentOf(DominatorNode node)` Returns the parent of node in the tree, null if the node is at the root.
`java.util.List<DominatorNode>`	`getPredsOf(DominatorNode node)` Finds all the predecessors of node in the original DirectedGraph and returns a list of the corresponding DominatorNodes.
`java.util.List<DominatorNode>`	`getSuccsOf(DominatorNode node)` Finds all the successors of node in the original DirectedGraph and returns a list of the corresponding DominatorNodes.
`java.util.List`	`getTails()` Returns a list of the tails of the dominator tree.
`boolean`	`isDominatorOf(DominatorNode dom, DominatorNode node)` Returns true if dom dominates node.
`boolean`	`isImmediateDominatorOf(DominatorNode idom, DominatorNode node)` Returns true if idom immediately dominates node.
`java.util.Iterator`	`iterator()` Returns an iterator over the nodes in the tree.
`int`	`size()` Returns the number of nodes in the tree.

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

- Field Detail
  - dominators
```
protected DominatorsFinder dominators
```
  - graph
```
protected DirectedGraph graph
```
  - head
```
protected DominatorNode head
```
  - tails
```
protected java.util.ArrayList tails
```
  - godeToDode
```
protected java.util.HashMap godeToDode
```
    "gode" is a node in the original graph, "dode" is a node in the dominator tree.
- Constructor Detail
  - DominatorTree
```
public DominatorTree(DominatorsFinder dominators)
```
- Method Detail
  - getGraph
```
public DirectedGraph getGraph()
```
    Returns the original graph to which the Dominator tree pertains.
  - getHead
```
public DominatorNode getHead()
```
    Returns the root of the dominator tree.
  - getTails
```
public java.util.List getTails()
```
    Returns a list of the tails of the dominator tree.
  - getParentOf
```
public DominatorNode getParentOf(DominatorNode node)
```
    Returns the parent of node in the tree, null if the node is at the root.
  - getChildrenOf
```
public java.util.List getChildrenOf(DominatorNode node)
```
    Returns the children of node in the tree.
  - getPredsOf
```
public java.util.List<DominatorNode> getPredsOf(DominatorNode node)
```
    Finds all the predecessors of node in the original DirectedGraph and returns a list of the corresponding DominatorNodes.
  - getSuccsOf
```
public java.util.List<DominatorNode> getSuccsOf(DominatorNode node)
```
    Finds all the successors of node in the original DirectedGraph and returns a list of the corresponding DominatorNodes.
  - isImmediateDominatorOf
```
public boolean isImmediateDominatorOf(DominatorNode idom,
                                      DominatorNode node)
```
    Returns true if idom immediately dominates node.
  - isDominatorOf
```
public boolean isDominatorOf(DominatorNode dom,
                             DominatorNode node)
```
    Returns true if dom dominates node.
  - getDode
```
public DominatorNode getDode(java.lang.Object gode)
```
    Returns the DominatorNode for a given node in the original DirectedGraph.
  - iterator
```
public java.util.Iterator iterator()
```
    Returns an iterator over the nodes in the tree. No ordering is implied.
  - size
```
public int size()
```
    Returns the number of nodes in the tree.
  - buildTree
```
protected void buildTree()
```
    Add all the necessary links between nodes to form a meaningful tree structure.
  - fetchDode
```
protected DominatorNode fetchDode(java.lang.Object gode)
```
    Convenience method, ensures we don't create more than one DominatorNode for a given block.
  - fetchParent
```
protected DominatorNode fetchParent(java.lang.Object gode)
```

Class DominatorTree

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dominators

graph

head

tails

godeToDode

Constructor Detail

DominatorTree

Method Detail

getGraph

getHead

getTails

getParentOf

getChildrenOf

getPredsOf

getSuccsOf

isImmediateDominatorOf

isDominatorOf

getDode

iterator

size

buildTree

fetchDode

fetchParent