ControlFlowGraph (checker-framework 3.5.0 API)

java.lang.Object
- org.checkerframework.dataflow.cfg.ControlFlowGraph

```
public class ControlFlowGraph
extends Object
```
A control flow graph (CFG for short) of a single method.

Field Summary

Fields
Modifier and Type	Field and Description
`protected IdentityHashMap<Tree,Set<Node>>`	`convertedTreeLookup` Map from AST `Tree`s to post-conversion sets of `Node`s.
`protected List<ClassTree>`	`declaredClasses` Class declarations that have been encountered when building the control-flow graph for a method.
`protected List<LambdaExpressionTree>`	`declaredLambdas` Lambdas encountered when building the control-flow graph for a method, variable initializer, or initializer.
`protected SpecialBlock`	`entryBlock` The entry block of the control flow graph.
`protected SpecialBlock`	`exceptionalExitBlock` The exceptional exit block of the control flow graph.
`protected SpecialBlock`	`regularExitBlock` The regular exit block of the control flow graph.
`protected List<ReturnNode>`	`returnNodes` All return nodes (if any) encountered.
`protected IdentityHashMap<Tree,Set<Node>>`	`treeLookup` Maps from AST `Tree`s to sets of `Node`s.
`protected IdentityHashMap<UnaryTree,AssignmentNode>`	`unaryAssignNodeLookup` Map from AST `UnaryTree`s to corresponding `AssignmentNode`s.
`protected UnderlyingAST`	`underlyingAST` The AST this CFG corresponds to.

Constructor Summary

Constructors
Constructor and Description
`ControlFlowGraph(SpecialBlock entryBlock, SpecialBlockImpl regularExitBlock, SpecialBlockImpl exceptionalExitBlock, UnderlyingAST underlyingAST, IdentityHashMap<Tree,Set<Node>> treeLookup, IdentityHashMap<Tree,Set<Node>> convertedTreeLookup, IdentityHashMap<UnaryTree,AssignmentNode> unaryAssignNodeLookup, List<ReturnNode> returnNodes, List<ClassTree> declaredClasses, List<LambdaExpressionTree> declaredLambdas)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Set<Block>`	`getAllBlocks()` Returns the set of all basic block in this control flow graph.
`@Nullable ClassTree`	`getContainingClass(Tree t)` Get the `ClassTree` of the CFG if the argument `Tree` maps to a `Node` in the CFG or null otherwise.
`@Nullable MethodTree`	`getContainingMethod(Tree t)` Get the `MethodTree` of the CFG if the argument `Tree` maps to a `Node` in the CFG or null otherwise.
`List<ClassTree>`	`getDeclaredClasses()`
`List<LambdaExpressionTree>`	`getDeclaredLambdas()`
`List<Block>`	`getDepthFirstOrderedBlocks()` Rreturns the list of all basic block in this control flow graph in reversed depth-first postorder sequence.
`SpecialBlock`	`getEntryBlock()` Returns the entry block of the control flow graph.
`SpecialBlock`	`getExceptionalExitBlock()`
`@Nullable Set<Node>`	`getNodesCorrespondingToTree(Tree t)` Returns the set of `Node`s to which the `Tree` `t` corresponds, or null for trees that don't produce a value.
`SpecialBlock`	`getRegularExitBlock()`
`List<ReturnNode>`	`getReturnNodes()`
`IdentityHashMap<Tree,Set<Node>>`	`getTreeLookup()` Returns the copied tree-lookup map.
`IdentityHashMap<UnaryTree,AssignmentNode>`	`getUnaryAssignNodeLookup()` Returns the copied lookup-map of the assign node for unary operation.
`UnderlyingAST`	`getUnderlyingAST()` Returns the AST this CFG corresponds to.
`String`	`toString()`

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

- Field Detail
  - entryBlock
```
protected final SpecialBlock entryBlock
```
    The entry block of the control flow graph.
  - regularExitBlock
```
protected final SpecialBlock regularExitBlock
```
    The regular exit block of the control flow graph.
  - exceptionalExitBlock
```
protected final SpecialBlock exceptionalExitBlock
```
    The exceptional exit block of the control flow graph.
  - underlyingAST
```
protected final UnderlyingAST underlyingAST
```
    The AST this CFG corresponds to.
  - treeLookup
```
protected final IdentityHashMap<Tree,Set<Node>> treeLookup
```
    Maps from AST Trees to sets of Nodes. Every Tree that produces a value will have at least one corresponding Node. Trees that undergo conversions, such as boxing or unboxing, can map to two distinct Nodes. The Node for the pre-conversion value is stored in treeLookup, while the Node for the post-conversion value is stored in convertedTreeLookup.
  - convertedTreeLookup
```
protected final IdentityHashMap<Tree,Set<Node>> convertedTreeLookup
```
    Map from AST Trees to post-conversion sets of Nodes.
  - unaryAssignNodeLookup
```
protected final IdentityHashMap<UnaryTree,AssignmentNode> unaryAssignNodeLookup
```
    Map from AST UnaryTrees to corresponding AssignmentNodes.
  - returnNodes
```
protected final List<ReturnNode> returnNodes
```
    All return nodes (if any) encountered. Only includes return statements that actually return something
  - declaredClasses
```
protected final List<ClassTree> declaredClasses
```
    Class declarations that have been encountered when building the control-flow graph for a method.
  - declaredLambdas
```
protected final List<LambdaExpressionTree> declaredLambdas
```
    Lambdas encountered when building the control-flow graph for a method, variable initializer, or initializer.
- Constructor Detail
  - ControlFlowGraph
```
public ControlFlowGraph(SpecialBlock entryBlock,
                        SpecialBlockImpl regularExitBlock,
                        SpecialBlockImpl exceptionalExitBlock,
                        UnderlyingAST underlyingAST,
                        IdentityHashMap<Tree,Set<Node>> treeLookup,
                        IdentityHashMap<Tree,Set<Node>> convertedTreeLookup,
                        IdentityHashMap<UnaryTree,AssignmentNode> unaryAssignNodeLookup,
                        List<ReturnNode> returnNodes,
                        List<ClassTree> declaredClasses,
                        List<LambdaExpressionTree> declaredLambdas)
```
- Method Detail
  - getNodesCorrespondingToTree
```
public @Nullable Set<Node> getNodesCorrespondingToTree(Tree t)
```
    Returns the set of Nodes to which the Tree t corresponds, or null for trees that don't produce a value.
    
    Parameters:
    
    t - a tree
    
    Returns:
    
    the set of Nodes to which the Tree t corresponds, or null for trees that don't produce a value
  - getEntryBlock
```
public SpecialBlock getEntryBlock()
```
    Returns the entry block of the control flow graph.
    
    Returns:
    
    the entry block of the control flow graph
  - getReturnNodes
```
public List<ReturnNode> getReturnNodes()
```
  - getRegularExitBlock
```
public SpecialBlock getRegularExitBlock()
```
  - getExceptionalExitBlock
```
public SpecialBlock getExceptionalExitBlock()
```
  - getUnderlyingAST
```
public UnderlyingAST getUnderlyingAST()
```
    Returns the AST this CFG corresponds to.
    
    Returns:
    
    the AST this CFG corresponds to
  - getAllBlocks
```
public Set<Block> getAllBlocks()
```
    Returns the set of all basic block in this control flow graph.
    
    Returns:
    
    the set of all basic block in this control flow graph
  - getDepthFirstOrderedBlocks
```
public List<Block> getDepthFirstOrderedBlocks()
```
    Rreturns the list of all basic block in this control flow graph in reversed depth-first postorder sequence. Blocks may appear more than once in the sequence.
    
    Returns:
    
    the list of all basic block in this control flow graph in reversed depth-first postorder sequence
  - getTreeLookup
```
public IdentityHashMap<Tree,Set<Node>> getTreeLookup()
```
    Returns the copied tree-lookup map.
    
    Returns:
    
    the copied tree-lookup map
  - getUnaryAssignNodeLookup
```
public IdentityHashMap<UnaryTree,AssignmentNode> getUnaryAssignNodeLookup()
```
    Returns the copied lookup-map of the assign node for unary operation.
    
    Returns:
    
    the copied lookup-map of the assign node for unary operation
  - getContainingMethod
```
public @Nullable MethodTree getContainingMethod(Tree t)
```
    Get the MethodTree of the CFG if the argument Tree maps to a Node in the CFG or null otherwise.
  - getContainingClass
```
public @Nullable ClassTree getContainingClass(Tree t)
```
    Get the ClassTree of the CFG if the argument Tree maps to a Node in the CFG or null otherwise.
  - getDeclaredClasses
```
public List<ClassTree> getDeclaredClasses()
```
  - getDeclaredLambdas
```
public List<LambdaExpressionTree> getDeclaredLambdas()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ControlFlowGraph

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

entryBlock

regularExitBlock

exceptionalExitBlock

underlyingAST

treeLookup

convertedTreeLookup

unaryAssignNodeLookup

returnNodes

declaredClasses

declaredLambdas

Constructor Detail

ControlFlowGraph

Method Detail

getNodesCorrespondingToTree

getEntryBlock

getReturnNodes

getRegularExitBlock

getExceptionalExitBlock

getUnderlyingAST

getAllBlocks

getDepthFirstOrderedBlocks

getTreeLookup

getUnaryAssignNodeLookup

getContainingMethod

getContainingClass

getDeclaredClasses

getDeclaredLambdas

toString