Class ControlFlowVisitor

java.lang.Object

com.sun.source.util.SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

com.google.errorprone.refaster.ControlFlowVisitor

All Implemented Interfaces:

TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

public class ControlFlowVisitor
extends SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Analyzes a series of statements to determine whether they don't, sometimes, or never return.

Author:

lowasser@google.com (Louis Wasserman)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ControlFlowVisitor.Result	The state of whether a sequence of statements may return, break out of the visited statements, or neither.

Field Summary

Fields

Modifier and Type	Field	Description
static final ControlFlowVisitor	INSTANCE

Fields inherited from class SimpleTreeVisitor

DEFAULT_VALUE

Method Summary

Modifier and Type	Method	Description
protected ControlFlowVisitor.Result	defaultAction(Tree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitBlock(BlockTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitBreak(BreakTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitCase(CaseTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitCatch(CatchTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitContinue(ContinueTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitDoWhileLoop(DoWhileLoopTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitEnhancedForLoop(EnhancedForLoopTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitExpressionStatement(ExpressionStatementTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitForLoop(ForLoopTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitIf(IfTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitLabeledStatement(LabeledStatementTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitReturn(ReturnTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitStatement(StatementTree node)
ControlFlowVisitor.Result	visitStatements(Iterable<? extends StatementTree> nodes)
ControlFlowVisitor.Result	visitSwitch(SwitchTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitSynchronized(SynchronizedTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitThrow(ThrowTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitTry(TryTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)
ControlFlowVisitor.Result	visitWhileLoop(WhileLoopTree node, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Methods inherited from class SimpleTreeVisitor

visit, visit, visitAnnotatedType, visitAnnotation, visitAnyPattern, visitArrayAccess, visitArrayType, visitAssert, visitAssignment, visitBinary, visitBindingPattern, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitConstantCaseLabel, visitDeconstructionPattern, visitDefaultCaseLabel, visitEmptyStatement, visitErroneous, visitExports, visitIdentifier, visitImport, visitInstanceOf, visitIntersectionType, visitLambdaExpression, visitLiteral, visitMemberReference, visitMemberSelect, visitMethod, visitMethodInvocation, visitModifiers, visitModule, visitNewArray, visitNewClass, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPatternCaseLabel, visitPrimitiveType, visitProvides, visitRequires, visitSwitchExpression, visitTypeCast, visitTypeParameter, visitUnary, visitUnionType, visitUses, visitVariable, visitWildcard, visitYield

Methods inherited from class Object

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

Field Details

INSTANCE

public static final ControlFlowVisitor INSTANCE

Method Details

visitStatement

public ControlFlowVisitor.Result visitStatement(StatementTree node)

visitStatements

public ControlFlowVisitor.Result visitStatements(Iterable<? extends StatementTree> nodes)

defaultAction

protected ControlFlowVisitor.Result defaultAction(Tree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Overrides:

defaultAction in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitBlock

public ControlFlowVisitor.Result visitBlock(BlockTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitBlock in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitBlock in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitDoWhileLoop

public ControlFlowVisitor.Result visitDoWhileLoop(DoWhileLoopTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitDoWhileLoop in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitDoWhileLoop in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitWhileLoop

public ControlFlowVisitor.Result visitWhileLoop(WhileLoopTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitWhileLoop in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitWhileLoop in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitForLoop

public ControlFlowVisitor.Result visitForLoop(ForLoopTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitForLoop in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitForLoop in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitEnhancedForLoop

public ControlFlowVisitor.Result visitEnhancedForLoop(EnhancedForLoopTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitEnhancedForLoop in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitEnhancedForLoop in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitSwitch

public ControlFlowVisitor.Result visitSwitch(SwitchTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitSwitch in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitSwitch in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitCase

public ControlFlowVisitor.Result visitCase(CaseTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitCase in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitCase in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitSynchronized

public ControlFlowVisitor.Result visitSynchronized(SynchronizedTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitSynchronized in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitSynchronized in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitTry

public ControlFlowVisitor.Result visitTry(TryTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitTry in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitTry in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitCatch

public ControlFlowVisitor.Result visitCatch(CatchTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitCatch in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitCatch in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitIf

public ControlFlowVisitor.Result visitIf(IfTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitIf in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitIf in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitExpressionStatement

public ControlFlowVisitor.Result visitExpressionStatement(ExpressionStatementTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitExpressionStatement in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitExpressionStatement in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitLabeledStatement

public ControlFlowVisitor.Result visitLabeledStatement(LabeledStatementTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitLabeledStatement in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitLabeledStatement in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitBreak

public ControlFlowVisitor.Result visitBreak(BreakTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitBreak in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitBreak in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitContinue

public ControlFlowVisitor.Result visitContinue(ContinueTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitContinue in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitContinue in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitReturn

public ControlFlowVisitor.Result visitReturn(ReturnTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitReturn in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitReturn in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

visitThrow

public ControlFlowVisitor.Result visitThrow(ThrowTree node,
 com.google.errorprone.refaster.ControlFlowVisitor.BreakContext cxt)

Specified by:

visitThrow in interface TreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>

Overrides:

visitThrow in class SimpleTreeVisitor<ControlFlowVisitor.Result, com.google.errorprone.refaster.ControlFlowVisitor.BreakContext>