FlowAnalysisListener (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

```
public interface FlowAnalysisListener
```
Listener that is called back when syms interesting for flow analysis are compiled.

Since:

12.1.2.0.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`catchParameterUsed(SourceCatchParameter parameter, SourceSimpleNameExpression context)` Usage of a catch parameter.
`void`	`clear()` Called at the end of the flow analysis.
`boolean`	`declareField(SourceFieldVariable sym, SourceExpression initializer)` Declare or define a field.
`boolean`	`declareLocalVariable(SourceLocalVariable sym, SourceExpression initializer)` Declare or define a local variable.
`boolean`	`endBlock(SourceBlock sym)` End flow analysis of a block.
`boolean`	`endClass(SourceClass sym)` End flow analysis of a class.
`boolean`	`endConstructors(SourceClass sym)` End flow analysis for constructors.
`boolean`	`endDoCondition(SourceWrapperExpression condition)` End a do condition.
`boolean`	`endFieldDeclaration(SourceFieldDeclaration sym)` End flow analysis of a field declaration.
`boolean`	`endIfCondition(SourceWrapperExpression condition)` End an if condition.
`boolean`	`endInitializer(SourceClassInitializer initializer)` End flow analysis of an initializer.
`boolean`	`endLambdaExpression(SourceLambdaExpression sym)` End flow analysis of a lambda expression.
`boolean`	`endMethod(SourceMethod sym)` End flow analysis of a method.
`boolean`	`endStatement(SourceStatement statement)` End flow analysis of a statement.
`boolean`	`endStaticInitializers(SourceClass sym)` End flow analysis for static initializers.
`boolean`	`endSwitchCondition(SourceWrapperExpression condition)` End a switch condition.
`boolean`	`endSynchronizedExpression(SourceWrapperExpression expression)` End a synchronized expression.
`boolean`	`endWhileCondition(SourceWrapperExpression condition)` End a while condition.
`boolean`	`fieldUsed(SourceFieldVariable field, SourceExpression context)` Usage of a field.
`boolean`	`lambdaParameterUsed(SourceLambdaParameter parameter, SourceSimpleNameExpression context)` Usage of a lambda parameter.
`boolean`	`localVariableUsed(SourceLocalVariable local, SourceSimpleNameExpression context)` Usage of a local variable.
`boolean`	`methodCalled(SourceMethodCallExpression methodCall)` A method was called.
`boolean`	`newClassCreation(SourceNewClassExpression newClassExpr)` A new class is being created.
`boolean`	`parameterUsed(SourceFormalParameter parameter, SourceSimpleNameExpression context)` Usage of a parameter.
`boolean`	`startBlock(SourceBlock sym)` Start flow analysis of a block, which is the time to get the local variables of that block by calling SourceBlock.getLocalVariables().
`boolean`	`startClass(SourceClass sym)` Start flow analysis of a class.
`boolean`	`startConstructors(SourceClass sym)` Start flow analysis for constructors.
`boolean`	`startDoCondition(SourceWrapperExpression condition)` Start a do condition.
`boolean`	`startFieldDeclaration(SourceFieldDeclaration sym)` Start flow analysis of a field declaration.
`boolean`	`startIfCondition(SourceWrapperExpression condition)` Start an if condition.
`boolean`	`startInitializer(SourceClassInitializer initializer)` Start flow analysis of an initializer.
`boolean`	`startLambdaExpression(SourceLambdaExpression sym)` Start flow analysis of a lambda expression.
`boolean`	`startMethod(SourceMethod sym)` Start flow analysis of a method.
`boolean`	`startStatement(SourceStatement statement)` Start flow analysis of a statement.
`boolean`	`startStaticInitializers(SourceClass sym)` Start flow analysis for static initializers.
`boolean`	`startSwitchCondition(SourceWrapperExpression condition)` Start a switch condition.
`boolean`	`startSynchronizedExpression(SourceWrapperExpression expression)` Start a synchronized expression.
`boolean`	`startWhileCondition(SourceWrapperExpression condition)` Start a while condition.
`boolean`	`statementLabel(SourceStatementLabel sym)` Compiler encountered a statement label.
`boolean`	`switchLabel(SourceSwitchLabel sym)` Compiler encountered a case label in a switch.

- Method Detail
  - clear
```
void clear()
```
    Called at the end of the flow analysis.
  - startClass
```
boolean startClass(SourceClass sym)
```
    Start flow analysis of a class.
    
    Parameters:
    
    sym - The class sym
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endClass
```
boolean endClass(SourceClass sym)
```
    End flow analysis of a class.
    
    Parameters:
    
    sym - The class sym
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startStaticInitializers
```
boolean startStaticInitializers(SourceClass sym)
```
    Start flow analysis for static initializers.
    
    Parameters:
    
    sym - The class sym that owns the static initializers
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endStaticInitializers
```
boolean endStaticInitializers(SourceClass sym)
```
    End flow analysis for static initializers.
    
    Parameters:
    
    sym - The class sym that owns the static initializers
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startInitializer
```
boolean startInitializer(SourceClassInitializer initializer)
```
    Start flow analysis of an initializer. Check isStatic() to determine if this is a static or an instance initializer.
    
    Parameters:
    
    initializer - The initializer
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endInitializer
```
boolean endInitializer(SourceClassInitializer initializer)
```
    End flow analysis of an initializer.
    
    Parameters:
    
    initializer - The initializer
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startConstructors
```
boolean startConstructors(SourceClass sym)
```
    Start flow analysis for constructors.
    
    Parameters:
    
    sym - The class sym that owns the constructors.
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endConstructors
```
boolean endConstructors(SourceClass sym)
```
    End flow analysis for constructors.
    
    Parameters:
    
    sym - The class sym that owns the constructors.
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startFieldDeclaration
```
boolean startFieldDeclaration(SourceFieldDeclaration sym)
```
    Start flow analysis of a field declaration.
    
    Parameters:
    
    sym - The field declaration sym
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endFieldDeclaration
```
boolean endFieldDeclaration(SourceFieldDeclaration sym)
```
    End flow analysis of a field declaration.
    
    Parameters:
    
    sym - The field declaration sym
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startMethod
```
boolean startMethod(SourceMethod sym)
```
    Start flow analysis of a method.
    
    Parameters:
    
    sym - The method sym
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endMethod
```
boolean endMethod(SourceMethod sym)
```
    End flow analysis of a method.
    
    Parameters:
    
    sym - The method sym
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startLambdaExpression
```
boolean startLambdaExpression(SourceLambdaExpression sym)
```
    Start flow analysis of a lambda expression.
    
    Parameters:
    
    sym - The lambda expression
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endLambdaExpression
```
boolean endLambdaExpression(SourceLambdaExpression sym)
```
    End flow analysis of a lambda expression.
    
    Parameters:
    
    sym - The lambda expression
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startBlock
```
boolean startBlock(SourceBlock sym)
```
    Start flow analysis of a block, which is the time to get the local variables of that block by calling SourceBlock.getLocalVariables().
    
    Parameters:
    
    sym - The block sym
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endBlock
```
boolean endBlock(SourceBlock sym)
```
    End flow analysis of a block.
    
    Parameters:
    
    sym - The block sym
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - declareField
```
boolean declareField(SourceFieldVariable sym,
                     SourceExpression initializer)
```
    Declare or define a field.
    
    Parameters:
    
    sym - The field
    
    initializer - If not null, this is the initializer of a define
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - declareLocalVariable
```
boolean declareLocalVariable(SourceLocalVariable sym,
                             SourceExpression initializer)
```
    Declare or define a local variable.
    
    Parameters:
    
    sym - The local variable
    
    initializer - If not null, this is the initializer of a define
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - statementLabel
```
boolean statementLabel(SourceStatementLabel sym)
```
    Compiler encountered a statement label.
    
    Parameters:
    
    sym - The label sym
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - switchLabel
```
boolean switchLabel(SourceSwitchLabel sym)
```
    Compiler encountered a case label in a switch.
    
    Parameters:
    
    sym - The label sym
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - localVariableUsed
```
boolean localVariableUsed(SourceLocalVariable local,
                          SourceSimpleNameExpression context)
```
    Usage of a local variable. The context is the expression where the local is used, and that context can be used to explore the larger context.
    
    Parameters:
    
    local - The local variable sym
    
    context - The expression context
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - fieldUsed
```
boolean fieldUsed(SourceFieldVariable field,
                  SourceExpression context)
```
    Usage of a field. The context is the expression where the field is used, and that context can be used to explore the larger context.
    
    Parameters:
    
    field - The field sym
    
    context - The expression context, should be a SourceSimpleNameExpression or a SourceDotExpression
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - parameterUsed
```
boolean parameterUsed(SourceFormalParameter parameter,
                      SourceSimpleNameExpression context)
```
    Usage of a parameter. The context is the expression where the parameter is used, and that context can be used to explore the larger context.
    
    Parameters:
    
    parameter - The parameter sym
    
    context - The expression context
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - catchParameterUsed
```
boolean catchParameterUsed(SourceCatchParameter parameter,
                           SourceSimpleNameExpression context)
```
    Usage of a catch parameter. The context is the expression where the catch parameter is used, and that context can be used to explore the larger context.
    
    Parameters:
    
    parameter - The catch parameter sym
    
    context - The expression context
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - lambdaParameterUsed
```
boolean lambdaParameterUsed(SourceLambdaParameter parameter,
                            SourceSimpleNameExpression context)
```
    Usage of a lambda parameter. The context is the expression where the lambda parameter is used, and that context can be used to explore the larger context.
    
    Parameters:
    
    parameter - The lambda parameter sym
    
    context - The expression context
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startStatement
```
boolean startStatement(SourceStatement statement)
```
    Start flow analysis of a statement. Use SourceStatement.getSymbolKind() to get the kind of statement (one of JavaConstants.SRC_STMT_XXX). A note about try statements: The flow of statements for try constructs is as follows: - startStatement( SourceTryStatement ) - for any catch: startStatement( SourceCatchClause ) endStatement( SourceCatchClause ) - endStatement( SourceTryStatement ) - for finally if existing: startStatement( SourceFinallyClause ) endStatement( SourceFinallyClause )
    
    Parameters:
    
    statement - The statement sym
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endStatement
```
boolean endStatement(SourceStatement statement)
```
    End flow analysis of a statement. Use SourceStatement.getSymbolKind() to get the kind of statement (one of JavaConstants.SRC_STMT_XXX).
    
    Parameters:
    
    statement - The statement sym
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - methodCalled
```
boolean methodCalled(SourceMethodCallExpression methodCall)
```
    A method was called.
    
    Parameters:
    
    methodCall - The method call expression
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - newClassCreation
```
boolean newClassCreation(SourceNewClassExpression newClassExpr)
```
    A new class is being created.
    
    Parameters:
    
    newClassExpr - The new class creation expression.
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startIfCondition
```
boolean startIfCondition(SourceWrapperExpression condition)
```
    Start an if condition.
    
    Parameters:
    
    condition - An if condition
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endIfCondition
```
boolean endIfCondition(SourceWrapperExpression condition)
```
    End an if condition.
    
    Parameters:
    
    condition - An if condition
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startWhileCondition
```
boolean startWhileCondition(SourceWrapperExpression condition)
```
    Start a while condition.
    
    Parameters:
    
    condition - A while condition
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endWhileCondition
```
boolean endWhileCondition(SourceWrapperExpression condition)
```
    End a while condition.
    
    Parameters:
    
    condition - A while condition
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startDoCondition
```
boolean startDoCondition(SourceWrapperExpression condition)
```
    Start a do condition.
    
    Parameters:
    
    condition - A do condition
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endDoCondition
```
boolean endDoCondition(SourceWrapperExpression condition)
```
    End a do condition.
    
    Parameters:
    
    condition - A do condition
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startSwitchCondition
```
boolean startSwitchCondition(SourceWrapperExpression condition)
```
    Start a switch condition.
    
    Parameters:
    
    condition - A switch condition
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endSwitchCondition
```
boolean endSwitchCondition(SourceWrapperExpression condition)
```
    End a switch condition.
    
    Parameters:
    
    condition - A switch condition
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - startSynchronizedExpression
```
boolean startSynchronizedExpression(SourceWrapperExpression expression)
```
    Start a synchronized expression.
    
    Parameters:
    
    expression - An expression
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted
  - endSynchronizedExpression
```
boolean endSynchronizedExpression(SourceWrapperExpression expression)
```
    End a synchronized expression.
    
    Parameters:
    
    expression - An expression
    
    Returns:
    
    True if the method succeeded, false if not in which case the flow analysis is aborted

Interface FlowAnalysisListener

Method Summary

Method Detail

clear

startClass

endClass

startStaticInitializers

endStaticInitializers

startInitializer

endInitializer

startConstructors

endConstructors

startFieldDeclaration

endFieldDeclaration

startMethod

endMethod

startLambdaExpression

endLambdaExpression

startBlock

endBlock

declareField

declareLocalVariable

statementLabel

switchLabel

localVariableUsed

fieldUsed

parameterUsed

catchParameterUsed

lambdaParameterUsed

startStatement

endStatement

methodCalled

newClassCreation

startIfCondition

endIfCondition

startWhileCondition

endWhileCondition

startDoCondition

endDoCondition

startSwitchCondition

endSwitchCondition

startSynchronizedExpression

endSynchronizedExpression