com.github.javaparser.symbolsolver.javaparsermodel

Class NormalCompletionVisitor

java.lang.Object

com.github.javaparser.ast.visitor.GenericVisitorWithDefaults<Boolean,Void>

com.github.javaparser.symbolsolver.javaparsermodel.NormalCompletionVisitor

All Implemented Interfaces:

GenericVisitor<Boolean,Void>

public class NormalCompletionVisitor
extends GenericVisitorWithDefaults<Boolean,Void>

When deciding into which scope pattern variables should be introduced, it is sometimes necessary to determine whether a statement can complete normally https://docs.oracle.com/javase/specs/jls/se22/html/jls-14.html#jls-14.22. The JLS specifies that a statement can complete normally only if it is reachable and specifies rules for what it means for a statement to be reachable, but that part can be ignored in JavaParser since having unreachable code results in a compilation error and is thus not supported. This means that all of the rules are implemented with the assumption that provided nodes are reachable. An example of where this is needed is for the following rule regarding pattern variables introduced by if-statements. 6.3.2.2. if Statements https://docs.oracle.com/javase/specs/jls/se22/html/jls-6.html#jls-6.3.2.2: The following rules apply to a statement if (e) S (§14.9.1): A pattern variable is introduced by if (e) S iff (i) it is introduced by e when false and (ii) S cannot complete normally. This means that in this example: if (!(x instanceof Foo f)) { return; } System.out.println(f); f will be in scope for the println call since the block making up the then-block of the if statement (S in the rule above) cannot complete normally (since the last statement, return, cannot complete normally). But, in this example: if (!(x instanceof Foo f)) { } f is not introduced by the if statement since the empty then-block can complete normally.

Constructor Summary

Constructors

Constructor and Description
NormalCompletionVisitor()

Method Summary

Modifier and Type	Method and Description
static boolean	containsCorrespondingBreak(Statement statement)
Boolean	defaultAction(Node n, Void unused)
Boolean	visit(BlockStmt block, Void unused) An empty block that is not a switch block can complete normally iff it is reachable.
Boolean	visit(BreakStmt breakStmt, Void unused) A break statement cannot complete normally.
Boolean	visit(ContinueStmt continueStmt, Void unused) A continue statement cannot complete normally.
Boolean	visit(DoStmt doStmt, Void unused) A do statement can complete normally iff at least one of the following is true: - The contained statement can complete normally and the condition expression is not a constant expression with value true
Boolean	visit(ForStmt forStmt, Void unused) A basic for statement can complete normally iff at least one of the following is true: - The for statement is reachable, there is a condition expression, and the condition expression is not a constant expression with value true
Boolean	visit(IfStmt ifStmt, Void unused) An if-then statement can complete normally iff it is reachable.
Boolean	visit(LabeledStmt labeledStmt, Void unused) A labeled statement can complete normally if at least one of the following is true: - The contained statement can complete normally
Boolean	visit(ReturnStmt returnStmt, Void unused) A return statement cannot complete normally.
Boolean	visit(SwitchStmt switchStmt, Void unused) A switch statement whose switch block is empty, or contains only switch labels, can complete normally.
Boolean	visit(SynchronizedStmt synchronizedStmt, Void unused) A synchronized statement can complete normally iff the contained statement can complete normally.
Boolean	visit(ThrowStmt throwStmt, Void unused) A throw statement cannot complete normally.
Boolean	visit(TryStmt tryStmt, Void unused) A try statement can complete normally iff both of the following are true: - The try block can complete normally or any catch block can complete normally
Boolean	visit(WhileStmt whileStmt, Void unused) A while statement can complete normally iff at least one of the following is true: - The while statement is reachable and the condition expression is not a constant expression with value true
Boolean	visit(YieldStmt yieldStmt, Void unused) A yield statement cannot complete normally.

Methods inherited from class com.github.javaparser.ast.visitor.GenericVisitorWithDefaults

defaultAction, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NormalCompletionVisitor

public NormalCompletionVisitor()

Method Detail

defaultAction

public Boolean defaultAction(Node n,
                             Void unused)

Overrides:

defaultAction in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(BreakStmt breakStmt,
                     Void unused)

A break statement cannot complete normally.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(ContinueStmt continueStmt,
                     Void unused)

A continue statement cannot complete normally.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(ReturnStmt returnStmt,
                     Void unused)

A return statement cannot complete normally.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(ThrowStmt throwStmt,
                     Void unused)

A throw statement cannot complete normally.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(YieldStmt yieldStmt,
                     Void unused)

A yield statement cannot complete normally.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(BlockStmt block,
                     Void unused)

An empty block that is not a switch block can complete normally iff it is reachable. A non-empty block that is not a switch block can complete normally iff the last statement in it can complete normally. The first statement in a non-empty block that is not a switch block is reachable iff the block is reachable. Every other statement S in a non-empty block that is not a switch block is reachable iff the statement preceding S can complete normally.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(LabeledStmt labeledStmt,
                     Void unused)

A labeled statement can complete normally if at least one of the following is true: - The contained statement can complete normally. - There is a reachable break statement that exits the labeled statement.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(IfStmt ifStmt,
                     Void unused)

An if-then statement can complete normally iff it is reachable. An if-then-else statement can complete normally iff the then-statement can complete normally or the else-statement can complete normally.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(WhileStmt whileStmt,
                     Void unused)

A while statement can complete normally iff at least one of the following is true: - The while statement is reachable and the condition expression is not a constant expression with value true. - There is a reachable break statement that exits the while statement.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(DoStmt doStmt,
                     Void unused)

A do statement can complete normally iff at least one of the following is true: - The contained statement can complete normally and the condition expression is not a constant expression with value true. - The do statement contains a reachable continue statement with no label, and the do statement is the innermost while, do, or for statement that contains that continue statement, and the continue statement continues that do statement, and the condition expression is not a constant expression with value true. - The do statement contains a reachable continue statement with label L, and the do statement has label L, and the continue statement continues that do statement, and the condition expression is not a constant expression with value true. - There is a reachable break statement that exits the do statement.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(ForStmt forStmt,
                     Void unused)

A basic for statement can complete normally iff at least one of the following is true: - The for statement is reachable, there is a condition expression, and the condition expression is not a constant expression with value true. - There is a reachable break statement that exits the for statement.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(SynchronizedStmt synchronizedStmt,
                     Void unused)

A synchronized statement can complete normally iff the contained statement can complete normally.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(TryStmt tryStmt,
                     Void unused)

A try statement can complete normally iff both of the following are true: - The try block can complete normally or any catch block can complete normally. - If the try statement has a finally block, then the finally block can complete normally.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

visit

public Boolean visit(SwitchStmt switchStmt,
                     Void unused)

A switch statement whose switch block is empty, or contains only switch labels, can complete normally. A switch statement whose switch block consists of switch labeled statement groups can complete normally iff at least one of the following is true: - The last statement in the switch block can complete normally. - There is at least one switch label after the last switch block statement group. - There is a reachable break statement that exits the switch statement. - The switch statement is not enhanced and its switch block does not contain a default label. A switch statement whose switch block consists of switch rules can complete normally iff at least one of the following is true: - One of the switch rules introduces a switch rule expression (which is necessarily a statement expression). - One of the switch rules introduces a switch rule block that can complete normally. - One of the switch rules introduces a switch rule block that contains a reachable break statement which exits the switch statement. - The switch statement is not enhanced and its switch block does not contain a default label.

Specified by:

visit in interface GenericVisitor<Boolean,Void>

Overrides:

visit in class GenericVisitorWithDefaults<Boolean,Void>

containsCorrespondingBreak

public static boolean containsCorrespondingBreak(Statement statement)

Parameters:

statement - should be one of: SwitchStatement, WhileStatement, DoStatement, ForStatement

Returns:

true if a break corresponding to the statement is found; false otherwise