CFGBuilder (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.codeInspection.dataFlow.CFGBuilder

```
public class CFGBuilder
extends java.lang.Object
```
A facade for building control flow graph used by CallInliner implementations

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CFGBuilder`	`assign()` Generate instructions to assign top stack value to the second stack value (usually pushed via `pushForWrite(DfaVariableValue)`).
`CFGBuilder`	`assign(DfaValue target, DfType source)` Generate instructions to assign given source value to the given target value and leave the result on stack.
`CFGBuilder`	`assignAndPop(DfaValue target, DfType source)` Generate instructions to assign given source value to the given target value.
`CFGBuilder`	`assignTo(DfaVariableValue var)` Generate instructions to assign top stack value to the specified variable
`CFGBuilder`	`assignTo(PsiVariable var)` Generate instructions to assign top stack value to the specified variable
`CFGBuilder`	`boxUnbox(PsiExpression expression, PsiType expectedType)` Generate instructions to box or unbox stack top value if necessary to satisfy the specified expected type.
`CFGBuilder`	`boxUnbox(PsiExpression expression, PsiType expressionType, PsiType expectedType)` Generate instructions to box or unbox stack top value if necessary to satisfy the specified expected type.
`CFGBuilder`	`call(PsiMethodCallExpression call)` Generate instructions to perform a method call without inlining
`CFGBuilder`	`catchAll()` Start catch section; must be created after `doTry(PsiElement)` section and finished with `end()`.
`CFGBuilder`	`chain(java.util.function.Consumer<? super CFGBuilder> operation)` A convenient method to chain specific builder operation
`DfaVariableValue`	`createTempVariable(PsiType type)` Create a synthetic variable (not declared in the original code) to be used within this control flow.
`CFGBuilder`	`doThrow(PsiType exceptionType)` Adds instructions to throw an exception of given type
`CFGBuilder`	`doTry(PsiElement anchor)` Start try section.
`CFGBuilder`	`doWhileUnknown()` Generate instructions to start a loop.
`CFGBuilder`	`dup()` Generate instructions to duplicate top stack value
`CFGBuilder`	`elseBranch()` Generate instructions to finish a "then-branch" and start an "else-branch" of a conditional block started with `ifCondition(IElementType)`, `ifConditionIs(boolean)`, `ifNull()` or `ifNotNull()`.
`CFGBuilder`	`end()` Generate instructions to finish a conditional block or a loop.
`CFGBuilder`	`evaluateFunction(PsiExpression functionalExpression)` Generate instructions to evaluate functional expression (but not invoke the function itself -- see `invokeFunction(int, PsiExpression)`).
`CFGBuilder`	`flush(DfaValue value)` Generate instruction to flush given value if it's variable.
`CFGBuilder`	`flushFields()` Generate instructions to flush known values of non-final fields of mutable classes.
`DfaValueFactory`	`getFactory()` Returns a `DfaValueFactory` associated with current control flow.
`CFGBuilder`	`ifCondition(IElementType relation)` Generate instructions to start a conditional block based on result of comparison of two stack values with given relation (e.g.
`CFGBuilder`	`ifConditionIs(boolean value)` Generate instructions to start a conditional block based on stack top value, consuming this value
`CFGBuilder`	`ifNotNull()` Generate instructions to start a conditional block which is executed if top stack value is not null.
`CFGBuilder`	`ifNull()` Generate instructions to start a conditional block which is executed if top stack value is null.
`CFGBuilder`	`invokeFunction(int argCount, PsiExpression functionalExpression)` Generates instructions to invoke functional expression (inlining it if possible) which consumes given amount of stack arguments, assuming that it was previously evaluated (see `evaluateFunction(PsiExpression)`).
`CFGBuilder`	`invokeFunction(int argCount, PsiExpression functionalExpression, Nullability resultNullability)` Generates instructions to invoke functional expression (inlining it if possible) which consumes given amount of stack arguments, assuming that it was previously evaluated (see `evaluateFunction(PsiExpression)`).
`CFGBuilder`	`isInstance(PsiExpression anchor, PsiExpression operand, PsiType castType)` Generate instructions to perform an instanceof operation
`CFGBuilder`	`isInstance(PsiMethodCallExpression anchor)` Generate instructions to perform an Class.isInstance operation
`CFGBuilder`	`loopOver(PsiExpression[] expressions, DfaVariableValue targetVariable)`
`CFGBuilder`	`objectOf()` Generate instructions to replace class value on top of stack with the corresponding object value
`CFGBuilder`	`pop()` Generate instructions to pop single DfaValue from stack
`CFGBuilder`	`push(DfaValue value)` Generate instructions to push given DfaValue on stack.
`CFGBuilder`	`push(DfaValue value, PsiExpression expression)` Generate instructions to push given DfaValue on stack and bind it to given expression.
`CFGBuilder`	`push(DfType value)` Generate instructions to push given DfType on stack.
`CFGBuilder`	`push(DfType value, PsiExpression expression)` Generate instructions to push given DfType on stack and bind it to given expression.
`CFGBuilder`	`pushExpression(PsiExpression expression)` Generate instructions to evaluate given expression and push its result on stack.
`CFGBuilder`	`pushExpression(PsiExpression expression, NullabilityProblemKind<? super PsiExpression> kind)` Generate instructions to evaluate given expression and push its result on stack checking for custom nullability problem which cannot be found automatically from context.
`CFGBuilder`	`pushForWrite(DfaVariableValue variable)` Generate instructions to push given variable value on stack for subsequent write.
`CFGBuilder`	`pushNull()` Generate instructions to push null DfaValue on stack.
`CFGBuilder`	`pushUnknown()` Generate instructions to push unknown DfaValue on stack.
`CFGBuilder`	`resultOf(PsiExpression expression)` Generate instructions to bind top-of-stack value to the given expression.
`CFGBuilder`	`splice(int count, int... replacement)` Generate instructions to pop given number of stack values, then push some or all of popped values referred by indices, possibly duplicating them
`CFGBuilder`	`swap()` Generate instructions to swap two top stack values
`boolean`	`tryInlineLambda(int argCount, PsiExpression functionalExpression, Nullability resultNullability, java.lang.Runnable pushArgs)`
`CFGBuilder`	`unwrap(SpecialField descriptor)` Generate instructions to load a special field value which qualifier is on the stack

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

- Method Detail
  - pushUnknown
```
public CFGBuilder pushUnknown()
```
    Generate instructions to push unknown DfaValue on stack.
    Stack before: ...
    Stack after: ... unknown
    
    Returns:
    
    this builder
  - pushNull
```
public CFGBuilder pushNull()
```
    Generate instructions to push null DfaValue on stack.
    Stack before: ...
    Stack after: ... null
    
    Returns:
    
    this builder
  - pushExpression
```
public CFGBuilder pushExpression(PsiExpression expression)
```
    Generate instructions to evaluate given expression and push its result on stack.
    Stack before: ...
    Stack after: ... expression_result
    
    Parameters:
    
    expression - expression to evaluate
    
    Returns:
    
    this builder
  - pushExpression
```
public CFGBuilder pushExpression(PsiExpression expression,
                                 NullabilityProblemKind<? super PsiExpression> kind)
```
    Generate instructions to evaluate given expression and push its result on stack checking for custom nullability problem which cannot be found automatically from context.
    Stack before: ...
    Stack after: ... expression_result
    
    Parameters:
    
    expression - expression to evaluate
    
    kind - kind of nullability problem. Use NullabilityProblemKind.noProblem to suppress automatically found problem. Passing null means no custom problem to register (just like pushExpression(PsiExpression)).
    
    Returns:
    
    this builder
  - unwrap
```
public CFGBuilder unwrap(SpecialField descriptor)
```
    Generate instructions to load a special field value which qualifier is on the stack
    Stack before: ... qualifier
    Stack after: ... loaded_field
    
    Parameters:
    
    descriptor - a SpecialField which describes a field to get
    
    Returns:
    
    this builder
  - pushForWrite
```
public CFGBuilder pushForWrite(DfaVariableValue variable)
```
    Generate instructions to push given variable value on stack for subsequent write.
    Stack before: ...
    Stack after: ... variable
    
    Parameters:
    
    variable - to push
    
    Returns:
    
    this builder
  - push
```
public CFGBuilder push(DfaValue value)
```
    Generate instructions to push given DfaValue on stack.
    Stack before: ...
    Stack after: ... value
    
    Parameters:
    
    value - value to push
    
    Returns:
    
    this builder
  - push
```
public CFGBuilder push(DfaValue value,
                       PsiExpression expression)
```
    Generate instructions to push given DfaValue on stack and bind it to given expression.
    Stack before: ...
    Stack after: ... value
    
    Parameters:
    
    value - value to push
    
    expression - expression which result is being pushed
    
    Returns:
    
    this builder
  - push
```
public CFGBuilder push(DfType value)
```
    Generate instructions to push given DfType on stack.
    Stack before: ...
    Stack after: ... value
    
    Parameters:
    
    value - value to push
    
    Returns:
    
    this builder
  - push
```
public CFGBuilder push(DfType value,
                       PsiExpression expression)
```
    Generate instructions to push given DfType on stack and bind it to given expression.
    Stack before: ...
    Stack after: ... value
    
    Parameters:
    
    value - value to push
    
    expression - expression which result is being pushed
    
    Returns:
    
    this builder
  - pop
```
public CFGBuilder pop()
```
    Generate instructions to pop single DfaValue from stack
    Stack before: ... value
    Stack after: ...
    
    Returns:
    
    this builder
  - dup
```
public CFGBuilder dup()
```
    Generate instructions to duplicate top stack value
    Stack before: ... value
    Stack after: ... value value
    
    Returns:
    
    this builder
  - splice
```
public CFGBuilder splice(int count,
                         int... replacement)
```
    Generate instructions to pop given number of stack values, then push some or all of popped values referred by indices, possibly duplicating them
    E.g. splice(2, 0, 1, 0) will change "... val1 val2" stack to "... val2 val1 val2". Stack depth is increased by replacement.length - count.
    
    Parameters:
    
    count - number of values to pop
    
    replacement - replacement indices from 0 to count-1. Index 0 = top stack value, index 1 = next value and so on.
    
    Returns:
    
    this builder
  - swap
```
public CFGBuilder swap()
```
    Generate instructions to swap two top stack values
    Stack before: ... val1 val2
    Stack after: ... val2 val1
    
    Returns:
    
    this builder
  - objectOf
```
public CFGBuilder objectOf()
```
    Generate instructions to replace class value on top of stack with the corresponding object value
    Stack before: ... class_value
    Stack after: ... object_value
    
    Returns:
    
    this builder
  - resultOf
```
public CFGBuilder resultOf(PsiExpression expression)
```
    Generate instructions to bind top-of-stack value to the given expression. Stack remains unchanged.
    
    Parameters:
    
    expression - expression to bind top-of-stack value to
    
    Returns:
    
    this builder
  - isInstance
```
public CFGBuilder isInstance(PsiMethodCallExpression anchor)
```
    Generate instructions to perform an Class.isInstance operation
    Stack before: ... object class_object
    Stack after: ... result
    
    Parameters:
    
    anchor - element to bind this instruction to
    
    Returns:
    
    this builder
  - isInstance
```
public CFGBuilder isInstance(PsiExpression anchor,
                             PsiExpression operand,
                             PsiType castType)
```
    Generate instructions to perform an instanceof operation
    Stack before: ... object cast_type
    Stack after: ... result
    
    Parameters:
    
    anchor - element to bind this instruction to
    
    operand - operand expression (pushed before)
    
    castType - cast type (pushed before)
    
    Returns:
    
    this builder
  - ifConditionIs
```
public CFGBuilder ifConditionIs(boolean value)
```
    Generate instructions to start a conditional block based on stack top value, consuming this value
    Stack before: ... condition
    Stack after: ...
    The conditional block must end with end() and may contain one elseBranch() inside. Nested conditional blocks are acceptable.
    
    Parameters:
    
    value - a value condition must have to visit conditional block
    
    Returns:
    
    this builder
  - ifCondition
```
public CFGBuilder ifCondition(IElementType relation)
```
    Generate instructions to start a conditional block based on result of comparison of two stack values with given relation (e.g. JavaTokenType.GT), consuming these values.
    Stack before: ... val1 val2
    Stack after: ...
    The conditional block must end with end() and may contain one elseBranch() inside. Nested conditional blocks are acceptable.
    
    Parameters:
    
    relation - a relation to use to compare two stack values. Conditional block will be executed if "val1 relation val2" is true.
    
    Returns:
    
    this builder
  - ifNotNull
```
public CFGBuilder ifNotNull()
```
    Generate instructions to start a conditional block which is executed if top stack value is not null.
    Stack before: ... value
    Stack after: ...
    The conditional block must end with end() and may contain one elseBranch() inside. Nested conditional blocks are acceptable.
    
    Returns:
    
    this builder
  - ifNull
```
public CFGBuilder ifNull()
```
    Generate instructions to start a conditional block which is executed if top stack value is null.
    Stack before: ... value
    Stack after: ...
    The conditional block must end with end() and may contain one elseBranch() inside. Nested conditional blocks are acceptable.
    
    Returns:
    
    this builder
  - end
```
public CFGBuilder end()
```
    Generate instructions to finish a conditional block or a loop. Stack is unchanged.
    
    Returns:
    
    this builder
  - elseBranch
```
public CFGBuilder elseBranch()
```
    Generate instructions to finish a "then-branch" and start an "else-branch" of a conditional block started with ifCondition(IElementType), ifConditionIs(boolean), ifNull() or ifNotNull(). Stack is unchanged.
    
    Returns:
    
    this builder
  - doWhileUnknown
```
public CFGBuilder doWhileUnknown()
```
    Generate instructions to start a loop. Stack is unchanged. Loop must be terminated via end(). Nested loops are acceptable.
    
    Returns:
    
    this builder
  - boxUnbox
```
public CFGBuilder boxUnbox(PsiExpression expression,
                           PsiType expectedType)
```
    Generate instructions to box or unbox stack top value if necessary to satisfy the specified expected type.
    Stack before: ... value
    Stack after: ... boxed_or_unboxed_value
    
    Parameters:
    
    expression - an expression which result is placed on the top of stack
    
    expectedType - an expected type
    
    Returns:
    
    this builder
  - boxUnbox
```
public CFGBuilder boxUnbox(PsiExpression expression,
                           PsiType expressionType,
                           PsiType expectedType)
```
    Generate instructions to box or unbox stack top value if necessary to satisfy the specified expected type.
    Stack before: ... value
    Stack after: ... boxed_or_unboxed_value
    
    Parameters:
    
    expression - an expression which is used to anchor instructions so issued warnings can point to this expression
    
    expressionType - an actual type of the expression on top of stack
    
    expectedType - an expected type
    
    Returns:
    
    this builder
  - flushFields
```
public CFGBuilder flushFields()
```
    Generate instructions to flush known values of non-final fields of mutable classes.
    
    Returns:
    
    this builder
  - flush
```
public CFGBuilder flush(DfaValue value)
```
    Generate instruction to flush given value if it's variable.
    
    Parameters:
    
    value - value to flush
    
    Returns:
    
    this builder
  - assign
```
public CFGBuilder assign()
```
    Generate instructions to assign top stack value to the second stack value (usually pushed via pushForWrite(DfaVariableValue)).
    Stack before: ... variable_for_write value
    Stack after: ... variable
    
    Returns:
    
    this builder
  - assignAndPop
```
public CFGBuilder assignAndPop(DfaValue target,
                               DfType source)
```
    Generate instructions to assign given source value to the given target value. Stack remains unchanged. May skip generating instructions if target is not writable (e.g. not a variable)
    
    Parameters:
    
    target - target to write
    
    source - source value
    
    Returns:
    
    this builder
  - assign
```
public CFGBuilder assign(DfaValue target,
                         DfType source)
```
    Generate instructions to assign given source value to the given target value and leave the result on stack.
    Stack before: ...
    Stack after: ... target
    
    Parameters:
    
    target - target to write
    
    source - source value
    
    Returns:
    
    this builder
  - doTry
```
public CFGBuilder doTry(PsiElement anchor)
```
    Start try section. All exceptions from it will be directed to the subsequent catchAll() section.
    
    Parameters:
    
    anchor - PSI anchor to handle nested traps
    
    Returns:
    
    this builder
  - catchAll
```
public CFGBuilder catchAll()
```
    Start catch section; must be created after doTry(PsiElement) section and finished with end().
    
    Returns:
    
    this builder
  - doThrow
```
public CFGBuilder doThrow(PsiType exceptionType)
```
    Adds instructions to throw an exception of given type
    
    Parameters:
    
    exceptionType - exception type to throw
    
    Returns:
    
    this builder
  - call
```
public CFGBuilder call(PsiMethodCallExpression call)
```
    Generate instructions to perform a method call without inlining
    Stack before: ... qualifier arg1 ... argN
    Stack after: ... method result
    
    Parameters:
    
    call - call to add
    
    Returns:
    
    this builder
  - assignTo
```
public CFGBuilder assignTo(PsiVariable var)
```
    Generate instructions to assign top stack value to the specified variable
    Stack before: ... value
    Stack after: ... variable
    
    Returns:
    
    this builder
  - assignTo
```
public CFGBuilder assignTo(DfaVariableValue var)
```
    Generate instructions to assign top stack value to the specified variable
    Stack before: ... value
    Stack after: ... variable
    
    Returns:
    
    this builder
  - getFactory
```
public DfaValueFactory getFactory()
```
    Returns a DfaValueFactory associated with current control flow.
    
    Returns:
    
    a DfaValueFactory associated with current control flow.
  - evaluateFunction
```
public CFGBuilder evaluateFunction(PsiExpression functionalExpression)
```
    Generate instructions to evaluate functional expression (but not invoke the function itself -- see invokeFunction(int, PsiExpression)). Stack is unchanged.
    
    Parameters:
    
    functionalExpression - a functional expression to evaluate
    
    Returns:
    
    this builder
  - invokeFunction
```
public CFGBuilder invokeFunction(int argCount,
                                 PsiExpression functionalExpression)
```
    Generates instructions to invoke functional expression (inlining it if possible) which consumes given amount of stack arguments, assuming that it was previously evaluated (see evaluateFunction(PsiExpression)).
    
    Parameters:
    
    argCount - number of stack arguments to consume
    
    functionalExpression - a functional expression to invoke
    
    Returns:
    
    this builder
  - invokeFunction
```
public CFGBuilder invokeFunction(int argCount,
                                 PsiExpression functionalExpression,
                                 Nullability resultNullability)
```
    Generates instructions to invoke functional expression (inlining it if possible) which consumes given amount of stack arguments, assuming that it was previously evaluated (see evaluateFunction(PsiExpression)).
    
    Parameters:
    
    argCount - number of stack arguments to consume
    
    functionalExpression - a functional expression to invoke
    
    resultNullability - an expected nullability of the lambda result
    
    Returns:
    
    this builder
  - tryInlineLambda
```
public boolean tryInlineLambda(int argCount,
                               PsiExpression functionalExpression,
                               Nullability resultNullability,
                               java.lang.Runnable pushArgs)
```
  - loopOver
```
public CFGBuilder loopOver(PsiExpression[] expressions,
                           DfaVariableValue targetVariable)
```
  - createTempVariable
```
public DfaVariableValue createTempVariable(PsiType type)
```
    Create a synthetic variable (not declared in the original code) to be used within this control flow.
    
    Parameters:
    
    type - a type of variable to create
    
    Returns:
    
    newly created variable
  - chain
```
public CFGBuilder chain(java.util.function.Consumer<? super CFGBuilder> operation)
```
    A convenient method to chain specific builder operation
    
    Parameters:
    
    operation - to execute on this builder
    
    Returns:
    
    this builder

Class CFGBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

pushUnknown

pushNull

pushExpression

pushExpression

unwrap

pushForWrite

push

push

push

push

pop

dup

splice

swap

objectOf

resultOf

isInstance

isInstance

ifConditionIs

ifCondition

ifNotNull

ifNull

end

elseBranch

doWhileUnknown

boxUnbox

boxUnbox

flushFields

flush

assign

assignAndPop

assign

doTry

catchAll

doThrow

call

assignTo

assignTo

getFactory

evaluateFunction

invokeFunction

invokeFunction

tryInlineLambda

loopOver

createTempVariable

chain