Package org.checkerframework.javacutil

Class SwitchExpressionScanner<R,P>

java.lang.Object

com.sun.source.util.TreeScanner<R,P>

org.checkerframework.javacutil.SwitchExpressionScanner<R,P>

Type Parameters:

R - the type of the result of visitSwitchResultExpression(ExpressionTree, Object)

P - the type of the parameter to pass to visitSwitchResultExpression(ExpressionTree, Object)

All Implemented Interfaces:

com.sun.source.tree.TreeVisitor<R,P>

Direct Known Subclasses:

SwitchExpressionScanner.FunctionalSwitchExpressionScanner

public abstract class SwitchExpressionScanner<R,P>
extends com.sun.source.util.TreeScanner<R,P>

A class that visits each result expression of a switch expression and calls visitSwitchResultExpression(ExpressionTree, Object) on each result expression. The results of these method calls are combined using combineResults(Object, Object). Call scanSwitchExpression(Tree, Object) to start scanning the switch expression.

SwitchExpressionScanner.FunctionalSwitchExpressionScanner can be used to pass functions for to use for visitSwitchResultExpression(ExpressionTree, Object) and combineResults(Object, Object).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SwitchExpressionScanner.FunctionalSwitchExpressionScanner<R1,P1>	An implementation of SwitchExpressionScanner that uses functions passed to the constructor for SwitchExpressionScanner.FunctionalSwitchExpressionScanner.visitSwitchResultExpression(ExpressionTree, Object) and SwitchExpressionScanner.FunctionalSwitchExpressionScanner.combineResults(Object, Object).
protected class	SwitchExpressionScanner.YieldVisitor	A scanner that visits all the yield trees in a given tree and calls visitSwitchResultExpression(ExpressionTree, Object) on the expression in the yield trees.

Field Summary

Fields

Modifier and Type	Field	Description
protected SwitchExpressionScanner.YieldVisitor	yieldVisitor	A scanner that visits all the yield trees in a given tree and calls visitSwitchResultExpression(ExpressionTree, Object) on the expression in the yield trees.

Constructor Summary

Constructors

Constructor	Description
SwitchExpressionScanner()

Method Summary

Modifier and Type	Method	Description
protected abstract R	combineResults(@Nullable R r1, @Nullable R r2)	This method combines the result of two calls to visitSwitchResultExpression(ExpressionTree, Object) or null and the result of one call to visitSwitchResultExpression(ExpressionTree, Object).
R	scanSwitchExpression(com.sun.source.tree.Tree switchExpression, P p)	Scans the given switch expression and calls visitSwitchResultExpression(ExpressionTree, Object) on each result expression of the switch expression.
protected abstract R	visitSwitchResultExpression(com.sun.source.tree.ExpressionTree resultExpressionTree, P p)	This method is called for each result expression of the switch expression passed in scanSwitchExpression(Tree, Object).

Methods inherited from class com.sun.source.util.TreeScanner

reduce, scan, scan, visitAnnotatedType, visitAnnotation, visitArrayAccess, visitArrayType, visitAssert, visitAssignment, visitBinary, visitBlock, visitBreak, visitCase, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitContinue, visitDoWhileLoop, visitEmptyStatement, visitEnhancedForLoop, visitErroneous, visitExports, visitExpressionStatement, visitForLoop, visitIdentifier, visitIf, visitImport, visitInstanceOf, visitIntersectionType, visitLabeledStatement, visitLambdaExpression, visitLiteral, visitMemberReference, visitMemberSelect, visitMethod, visitMethodInvocation, visitModifiers, visitModule, visitNewArray, visitNewClass, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPrimitiveType, visitProvides, visitRequires, visitReturn, visitSwitch, visitSynchronized, visitThrow, visitTry, visitTypeCast, visitTypeParameter, visitUnary, visitUnionType, visitUses, visitVariable, visitWhileLoop, visitWildcard

Methods inherited from class java.lang.Object

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

Field Detail

yieldVisitor

protected final SwitchExpressionScanner.YieldVisitor yieldVisitor

A scanner that visits all the yield trees in a given tree and calls visitSwitchResultExpression(ExpressionTree, Object) on the expression in the yield trees. It does not descend into switch expressions.

Constructor Detail

SwitchExpressionScanner

public SwitchExpressionScanner()

Method Detail

visitSwitchResultExpression

protected abstract R visitSwitchResultExpression(com.sun.source.tree.ExpressionTree resultExpressionTree,
                                                 P p)

This method is called for each result expression of the switch expression passed in scanSwitchExpression(Tree, Object).

Parameters:

resultExpressionTree - a result expression of the switch expression currently being scanned

p - a parameter

Returns:

the result of visiting the result expression

combineResults

protected abstract R combineResults(@Nullable R r1,
                                    @Nullable R r2)

This method combines the result of two calls to visitSwitchResultExpression(ExpressionTree, Object) or null and the result of one call to visitSwitchResultExpression(ExpressionTree, Object).

Parameters:

r1 - a possibly null result returned by visitSwitchResultExpression(ExpressionTree, Object)

r2 - a possibly null result returned by visitSwitchResultExpression(ExpressionTree, Object)

Returns:

the combination of r1 and r2

scanSwitchExpression

public R scanSwitchExpression(com.sun.source.tree.Tree switchExpression,
                              P p)

Scans the given switch expression and calls visitSwitchResultExpression(ExpressionTree, Object) on each result expression of the switch expression. combineResults(Object, Object) is called to combine the results of visiting multiple switch result expressions.

Parameters:

switchExpression - a switch expression tree

p - the parameter to pass to visitSwitchResultExpression(ExpressionTree, Object)

Returns:

the result of calling visitSwitchResultExpression(ExpressionTree, Object) on each result expression of switchExpression and combining the results using combineResults(Object, Object)