Package org.checkerframework.dataflow.cfg.node

Class AbstractNodeVisitor<R,P>

java.lang.Object

org.checkerframework.dataflow.cfg.node.AbstractNodeVisitor<R,P>

Type Parameters:

R - return type of the visitor

P - parameter type of the visitor

All Implemented Interfaces:

NodeVisitor<R,P>

Direct Known Subclasses:

BusyExprTransfer, CFAbstractTransfer, ConstantPropagationTransfer, LiveVarTransfer, ReachingDefinitionTransfer

public abstract class AbstractNodeVisitor<R,P>
extends Object
implements NodeVisitor<R,P>

A default implementation of the node visitor interface. The class introduces several 'summary' methods, that can be overridden to change the behavior of several related visit methods at once.

The summary methods and the nodes they handle are:

• visitNode(org.checkerframework.dataflow.cfg.node.Node, P) - All visit* methods eventually call this method by default.
  • visitValueLiteral(org.checkerframework.dataflow.cfg.node.ValueLiteralNode, P) - ValueLiteralNodes
  • visitUnaryOperation(org.checkerframework.dataflow.cfg.node.UnaryOperationNode, P) - UnaryOperationNodes
  • visitBinaryOperation(org.checkerframework.dataflow.cfg.node.BinaryOperationNode, P) - BinaryOperationNodes. The specialized visit methods for binary operation nodes delegate to this method by default:
    • visitBinaryNumericalOperation(org.checkerframework.dataflow.cfg.node.BinaryOperationNode, P) - numerical operations (arithmetic, bitwise, shifts)
    • visitBinaryComparisonOperation(org.checkerframework.dataflow.cfg.node.BinaryOperationNode, P) - comparison operations (<, <= >, >=, ==, !=)
    • visitBinaryConditionalOperation(org.checkerframework.dataflow.cfg.node.BinaryOperationNode, P) - conditional operations (&&, ||)
  • visitThis(org.checkerframework.dataflow.cfg.node.ThisNode, P) - this references (implicit and explicit)

This is useful to implement a visitor that performs the same operation (e.g., nothing) for most Nodes and only has special behavior for a few.

Constructor Summary

Constructors

Constructor	Description
AbstractNodeVisitor()	Create a new AbstractNodeVisitor.

Method Summary

Modifier and Type	Method	Description
R	visitAnyPattern(AnyPatternNode n, P p)	Visits an any pattern node.
R	visitArrayAccess(ArrayAccessNode n, P p)
R	visitArrayCreation(ArrayCreationNode n, P p)
R	visitArrayType(ArrayTypeNode n, P p)
R	visitAssertionError(AssertionErrorNode n, P p)
R	visitAssignment(AssignmentNode n, P p)
R	visitBinaryComparisonOperation(BinaryOperationNode n, P p)	Visits a binary comparison operation (<, <= >, >=, ==, !=).
R	visitBinaryConditionalOperation(BinaryOperationNode n, P p)	Visits a binary conditional operation (&&, ||).
R	visitBinaryNumericalOperation(BinaryOperationNode n, P p)	Visits a binary numerical operation node (+, -, *, /, %, <<, >>, >>>, &, |, ^).
R	visitBinaryOperation(BinaryOperationNode n, P p)	Visits any binary operation.
R	visitBitwiseAnd(BitwiseAndNode n, P p)
R	visitBitwiseComplement(BitwiseComplementNode n, P p)
R	visitBitwiseOr(BitwiseOrNode n, P p)
R	visitBitwiseXor(BitwiseXorNode n, P p)
R	visitBooleanLiteral(BooleanLiteralNode n, P p)
R	visitCase(CaseNode n, P p)
R	visitCharacterLiteral(CharacterLiteralNode n, P p)
R	visitClassDeclaration(ClassDeclarationNode n, P p)	Visits an anonymous/inner/nested class declaration within a method.
R	visitClassName(ClassNameNode n, P p)
R	visitConditionalAnd(ConditionalAndNode n, P p)
R	visitConditionalNot(ConditionalNotNode n, P p)
R	visitConditionalOr(ConditionalOrNode n, P p)
R	visitDeconstructorPattern(DeconstructorPatternNode n, P p)	Visits a deconstructor pattern node.
R	visitDoubleLiteral(DoubleLiteralNode n, P p)
R	visitEqualTo(EqualToNode n, P p)
R	visitExplicitThis(ExplicitThisNode n, P p)
R	visitExpressionStatement(ExpressionStatementNode n, P p)	Visits an expression that is used as a statement.
R	visitFieldAccess(FieldAccessNode n, P p)
R	visitFloatingDivision(FloatingDivisionNode n, P p)
R	visitFloatingRemainder(FloatingRemainderNode n, P p)
R	visitFloatLiteral(FloatLiteralNode n, P p)
R	visitGreaterThan(GreaterThanNode n, P p)
R	visitGreaterThanOrEqual(GreaterThanOrEqualNode n, P p)
R	visitImplicitThis(ImplicitThisNode n, P p)
R	visitInstanceOf(InstanceOfNode n, P p)
R	visitIntegerDivision(IntegerDivisionNode n, P p)
R	visitIntegerLiteral(IntegerLiteralNode n, P p)
R	visitIntegerRemainder(IntegerRemainderNode n, P p)
R	visitLambdaResultExpression(LambdaResultExpressionNode n, P p)
R	visitLeftShift(LeftShiftNode n, P p)
R	visitLessThan(LessThanNode n, P p)
R	visitLessThanOrEqual(LessThanOrEqualNode n, P p)
R	visitLocalVariable(LocalVariableNode n, P p)
R	visitLongLiteral(LongLiteralNode n, P p)
R	visitMarker(MarkerNode n, P p)
R	visitMemberReference(FunctionalInterfaceNode n, P p)
R	visitMethodAccess(MethodAccessNode n, P p)
R	visitMethodInvocation(MethodInvocationNode n, P p)
R	visitNarrowingConversion(NarrowingConversionNode n, P p)
abstract R	visitNode(Node n, P p)	Visits a node.
R	visitNotEqual(NotEqualNode n, P p)
R	visitNullChk(NullChkNode n, P p)
R	visitNullLiteral(NullLiteralNode n, P p)
R	visitNumericalAddition(NumericalAdditionNode n, P p)
R	visitNumericalMinus(NumericalMinusNode n, P p)
R	visitNumericalMultiplication(NumericalMultiplicationNode n, P p)
R	visitNumericalPlus(NumericalPlusNode n, P p)
R	visitNumericalSubtraction(NumericalSubtractionNode n, P p)
R	visitObjectCreation(ObjectCreationNode n, P p)
R	visitPackageName(PackageNameNode n, P p)
R	visitParameterizedType(ParameterizedTypeNode n, P p)
R	visitPrimitiveType(PrimitiveTypeNode n, P p)
R	visitReturn(ReturnNode n, P p)
R	visitShortLiteral(ShortLiteralNode n, P p)
R	visitSignedRightShift(SignedRightShiftNode n, P p)
R	visitStringConcatenate(StringConcatenateNode n, P p)
R	visitStringConversion(StringConversionNode n, P p)
R	visitStringLiteral(StringLiteralNode n, P p)
R	visitSuper(SuperNode n, P p)
R	visitSwitchExpressionNode(SwitchExpressionNode n, P p)
R	visitSynchronized(SynchronizedNode n, P p)
R	visitTernaryExpression(TernaryExpressionNode n, P p)
R	visitThis(ThisNode n, P p)	Visits a explicit or implicit this reference node.
R	visitThrow(ThrowNode n, P p)
R	visitTypeCast(TypeCastNode n, P p)
R	visitUnaryOperation(UnaryOperationNode n, P p)	Visits any unary operation.
R	visitUnsignedRightShift(UnsignedRightShiftNode n, P p)
R	visitValueLiteral(ValueLiteralNode n, P p)	Visits a value literal.
R	visitVariableDeclaration(VariableDeclarationNode n, P p)
R	visitWideningConversion(WideningConversionNode n, P p)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractNodeVisitor

public AbstractNodeVisitor()

Create a new AbstractNodeVisitor.

Method Details

visitNode

public abstract R visitNode(Node n,
 P p)

Visits a node. All other visit methods delegate to this method by default.

Parameters:

n - the node to visit

p - the input for the visitor

Returns:

the output produced by the visitor

visitValueLiteral

public R visitValueLiteral(ValueLiteralNode n,
 P p)

Visits a value literal.

Parameters:

n - the value literal node to visit

p - the input for the visitor

Returns:

the output produced by the visitor

visitShortLiteral

public R visitShortLiteral(ShortLiteralNode n,
 P p)

Specified by:

visitShortLiteral in interface NodeVisitor<R,P>

visitIntegerLiteral

public R visitIntegerLiteral(IntegerLiteralNode n,
 P p)

Specified by:

visitIntegerLiteral in interface NodeVisitor<R,P>

visitLongLiteral

public R visitLongLiteral(LongLiteralNode n,
 P p)

Specified by:

visitLongLiteral in interface NodeVisitor<R,P>

visitFloatLiteral

public R visitFloatLiteral(FloatLiteralNode n,
 P p)

Specified by:

visitFloatLiteral in interface NodeVisitor<R,P>

visitDoubleLiteral

public R visitDoubleLiteral(DoubleLiteralNode n,
 P p)

Specified by:

visitDoubleLiteral in interface NodeVisitor<R,P>

visitBooleanLiteral

public R visitBooleanLiteral(BooleanLiteralNode n,
 P p)

Specified by:

visitBooleanLiteral in interface NodeVisitor<R,P>

visitCharacterLiteral

public R visitCharacterLiteral(CharacterLiteralNode n,
 P p)

Specified by:

visitCharacterLiteral in interface NodeVisitor<R,P>

visitStringLiteral

public R visitStringLiteral(StringLiteralNode n,
 P p)

Specified by:

visitStringLiteral in interface NodeVisitor<R,P>

visitNullLiteral

public R visitNullLiteral(NullLiteralNode n,
 P p)

Specified by:

visitNullLiteral in interface NodeVisitor<R,P>

visitUnaryOperation

public R visitUnaryOperation(UnaryOperationNode n,
 P p)

Visits any unary operation.

Parameters:

n - the unary operation node to visit

p - the input for the visitor

Returns:

the output produced by the visitor

visitNumericalMinus

public R visitNumericalMinus(NumericalMinusNode n,
 P p)

Specified by:

visitNumericalMinus in interface NodeVisitor<R,P>

visitNumericalPlus

public R visitNumericalPlus(NumericalPlusNode n,
 P p)

Specified by:

visitNumericalPlus in interface NodeVisitor<R,P>

visitBitwiseComplement

public R visitBitwiseComplement(BitwiseComplementNode n,
 P p)

Specified by:

visitBitwiseComplement in interface NodeVisitor<R,P>

visitNullChk

public R visitNullChk(NullChkNode n,
 P p)

Specified by:

visitNullChk in interface NodeVisitor<R,P>

visitBinaryOperation

public R visitBinaryOperation(BinaryOperationNode n,
 P p)

Visits any binary operation.

Parameters:

n - the binary operation node to visit

p - the input for the visitor

Returns:

the output produced by the visitor

visitStringConcatenate

public R visitStringConcatenate(StringConcatenateNode n,
 P p)

Specified by:

visitStringConcatenate in interface NodeVisitor<R,P>

visitBinaryNumericalOperation

public R visitBinaryNumericalOperation(BinaryOperationNode n,
 P p)

Visits a binary numerical operation node (+, -, *, /, %, <<, >>, >>>, &, |, ^).

Parameters:

n - the binary numerical operation node to visit

p - the input for the visitor

Returns:

the output produced by the visitor

visitNumericalAddition

public R visitNumericalAddition(NumericalAdditionNode n,
 P p)

Specified by:

visitNumericalAddition in interface NodeVisitor<R,P>

visitNumericalSubtraction

public R visitNumericalSubtraction(NumericalSubtractionNode n,
 P p)

Specified by:

visitNumericalSubtraction in interface NodeVisitor<R,P>

visitNumericalMultiplication

public R visitNumericalMultiplication(NumericalMultiplicationNode n,
 P p)

Specified by:

visitNumericalMultiplication in interface NodeVisitor<R,P>

visitIntegerDivision

public R visitIntegerDivision(IntegerDivisionNode n,
 P p)

Specified by:

visitIntegerDivision in interface NodeVisitor<R,P>

visitFloatingDivision

public R visitFloatingDivision(FloatingDivisionNode n,
 P p)

Specified by:

visitFloatingDivision in interface NodeVisitor<R,P>

visitIntegerRemainder

public R visitIntegerRemainder(IntegerRemainderNode n,
 P p)

Specified by:

visitIntegerRemainder in interface NodeVisitor<R,P>

visitFloatingRemainder

public R visitFloatingRemainder(FloatingRemainderNode n,
 P p)

Specified by:

visitFloatingRemainder in interface NodeVisitor<R,P>

visitLeftShift

public R visitLeftShift(LeftShiftNode n,
 P p)

Specified by:

visitLeftShift in interface NodeVisitor<R,P>

visitSignedRightShift

public R visitSignedRightShift(SignedRightShiftNode n,
 P p)

Specified by:

visitSignedRightShift in interface NodeVisitor<R,P>

visitUnsignedRightShift

public R visitUnsignedRightShift(UnsignedRightShiftNode n,
 P p)

Specified by:

visitUnsignedRightShift in interface NodeVisitor<R,P>

visitBitwiseAnd

public R visitBitwiseAnd(BitwiseAndNode n,
 P p)

Specified by:

visitBitwiseAnd in interface NodeVisitor<R,P>

visitBitwiseOr

public R visitBitwiseOr(BitwiseOrNode n,
 P p)

Specified by:

visitBitwiseOr in interface NodeVisitor<R,P>

visitBitwiseXor

public R visitBitwiseXor(BitwiseXorNode n,
 P p)

Specified by:

visitBitwiseXor in interface NodeVisitor<R,P>

visitBinaryComparisonOperation

public R visitBinaryComparisonOperation(BinaryOperationNode n,
 P p)

Visits a binary comparison operation (<, <= >, >=, ==, !=).

Parameters:

n - the binary comparison operation node to visit

p - the input for the visitor

Returns:

the output produced by the visitor

visitLessThan

public R visitLessThan(LessThanNode n,
 P p)

Specified by:

visitLessThan in interface NodeVisitor<R,P>

visitLessThanOrEqual

public R visitLessThanOrEqual(LessThanOrEqualNode n,
 P p)

Specified by:

visitLessThanOrEqual in interface NodeVisitor<R,P>

visitGreaterThan

public R visitGreaterThan(GreaterThanNode n,
 P p)

Specified by:

visitGreaterThan in interface NodeVisitor<R,P>

visitGreaterThanOrEqual

public R visitGreaterThanOrEqual(GreaterThanOrEqualNode n,
 P p)

Specified by:

visitGreaterThanOrEqual in interface NodeVisitor<R,P>

visitEqualTo

public R visitEqualTo(EqualToNode n,
 P p)

Specified by:

visitEqualTo in interface NodeVisitor<R,P>

visitNotEqual

public R visitNotEqual(NotEqualNode n,
 P p)

Specified by:

visitNotEqual in interface NodeVisitor<R,P>

visitBinaryConditionalOperation

public R visitBinaryConditionalOperation(BinaryOperationNode n,
 P p)

Visits a binary conditional operation (&&, ||).

Parameters:

n - the binary conditional operation node to visit

p - the input for the visitor

Returns:

the output produced by the visitor

visitConditionalAnd

public R visitConditionalAnd(ConditionalAndNode n,
 P p)

Specified by:

visitConditionalAnd in interface NodeVisitor<R,P>

visitConditionalOr

public R visitConditionalOr(ConditionalOrNode n,
 P p)

Specified by:

visitConditionalOr in interface NodeVisitor<R,P>

visitConditionalNot

public R visitConditionalNot(ConditionalNotNode n,
 P p)

Specified by:

visitConditionalNot in interface NodeVisitor<R,P>

visitTernaryExpression

public R visitTernaryExpression(TernaryExpressionNode n,
 P p)

Specified by:

visitTernaryExpression in interface NodeVisitor<R,P>

visitSwitchExpressionNode

public R visitSwitchExpressionNode(SwitchExpressionNode n,
 P p)

Specified by:

visitSwitchExpressionNode in interface NodeVisitor<R,P>

visitAssignment

public R visitAssignment(AssignmentNode n,
 P p)

Specified by:

visitAssignment in interface NodeVisitor<R,P>

visitLocalVariable

public R visitLocalVariable(LocalVariableNode n,
 P p)

Specified by:

visitLocalVariable in interface NodeVisitor<R,P>

visitVariableDeclaration

public R visitVariableDeclaration(VariableDeclarationNode n,
 P p)

Specified by:

visitVariableDeclaration in interface NodeVisitor<R,P>

visitFieldAccess

public R visitFieldAccess(FieldAccessNode n,
 P p)

Specified by:

visitFieldAccess in interface NodeVisitor<R,P>

visitMethodAccess

public R visitMethodAccess(MethodAccessNode n,
 P p)

Specified by:

visitMethodAccess in interface NodeVisitor<R,P>

visitArrayAccess

public R visitArrayAccess(ArrayAccessNode n,
 P p)

Specified by:

visitArrayAccess in interface NodeVisitor<R,P>

visitThis

public R visitThis(ThisNode n,
 P p)

Visits a explicit or implicit this reference node.

Parameters:

n - the this node to visit

p - the input for the visitor

Returns:

the output produced by the visitor

visitImplicitThis

public R visitImplicitThis(ImplicitThisNode n,
 P p)

Specified by:

visitImplicitThis in interface NodeVisitor<R,P>

visitExplicitThis

public R visitExplicitThis(ExplicitThisNode n,
 P p)

Specified by:

visitExplicitThis in interface NodeVisitor<R,P>

visitSuper

public R visitSuper(SuperNode n,
 P p)

Specified by:

visitSuper in interface NodeVisitor<R,P>

visitReturn

public R visitReturn(ReturnNode n,
 P p)

Specified by:

visitReturn in interface NodeVisitor<R,P>

visitLambdaResultExpression

public R visitLambdaResultExpression(LambdaResultExpressionNode n,
 P p)

Specified by:

visitLambdaResultExpression in interface NodeVisitor<R,P>

visitStringConversion

public R visitStringConversion(StringConversionNode n,
 P p)

Specified by:

visitStringConversion in interface NodeVisitor<R,P>

visitWideningConversion

public R visitWideningConversion(WideningConversionNode n,
 P p)

Specified by:

visitWideningConversion in interface NodeVisitor<R,P>

visitNarrowingConversion

public R visitNarrowingConversion(NarrowingConversionNode n,
 P p)

Specified by:

visitNarrowingConversion in interface NodeVisitor<R,P>

visitInstanceOf

public R visitInstanceOf(InstanceOfNode n,
 P p)

Specified by:

visitInstanceOf in interface NodeVisitor<R,P>

visitTypeCast

public R visitTypeCast(TypeCastNode n,
 P p)

Specified by:

visitTypeCast in interface NodeVisitor<R,P>

visitAssertionError

public R visitAssertionError(AssertionErrorNode n,
 P p)

Specified by:

visitAssertionError in interface NodeVisitor<R,P>

visitSynchronized

public R visitSynchronized(SynchronizedNode n,
 P p)

Specified by:

visitSynchronized in interface NodeVisitor<R,P>

visitThrow

public R visitThrow(ThrowNode n,
 P p)

Specified by:

visitThrow in interface NodeVisitor<R,P>

visitCase

public R visitCase(CaseNode n,
 P p)

Specified by:

visitCase in interface NodeVisitor<R,P>

visitMethodInvocation

public R visitMethodInvocation(MethodInvocationNode n,
 P p)

Specified by:

visitMethodInvocation in interface NodeVisitor<R,P>

visitObjectCreation

public R visitObjectCreation(ObjectCreationNode n,
 P p)

Specified by:

visitObjectCreation in interface NodeVisitor<R,P>

visitClassDeclaration

public R visitClassDeclaration(ClassDeclarationNode n,
 P p)

Description copied from interface: NodeVisitor

Visits an anonymous/inner/nested class declaration within a method.

Specified by:

visitClassDeclaration in interface NodeVisitor<R,P>

Parameters:

n - the ClassDeclarationNode to be visited

p - the argument for the operation implemented by this visitor

Returns:

the return value of the operation implemented by this visitor

visitMemberReference

public R visitMemberReference(FunctionalInterfaceNode n,
 P p)

Specified by:

visitMemberReference in interface NodeVisitor<R,P>

visitArrayCreation

public R visitArrayCreation(ArrayCreationNode n,
 P p)

Specified by:

visitArrayCreation in interface NodeVisitor<R,P>

visitArrayType

public R visitArrayType(ArrayTypeNode n,
 P p)

Specified by:

visitArrayType in interface NodeVisitor<R,P>

visitPrimitiveType

public R visitPrimitiveType(PrimitiveTypeNode n,
 P p)

Specified by:

visitPrimitiveType in interface NodeVisitor<R,P>

visitClassName

public R visitClassName(ClassNameNode n,
 P p)

Specified by:

visitClassName in interface NodeVisitor<R,P>

visitPackageName

public R visitPackageName(PackageNameNode n,
 P p)

Specified by:

visitPackageName in interface NodeVisitor<R,P>

visitParameterizedType

public R visitParameterizedType(ParameterizedTypeNode n,
 P p)

Specified by:

visitParameterizedType in interface NodeVisitor<R,P>

visitMarker

public R visitMarker(MarkerNode n,
 P p)

Specified by:

visitMarker in interface NodeVisitor<R,P>

visitExpressionStatement

public R visitExpressionStatement(ExpressionStatementNode n,
 P p)

Description copied from interface: NodeVisitor

Visits an expression that is used as a statement. This node is a marker after the expression node(s).

Specified by:

visitExpressionStatement in interface NodeVisitor<R,P>

Parameters:

n - the ExpressionStatementNode to be visited

p - the argument for the operation implemented by this visitor

Returns:

the return value of the operation implemented by this visitor

visitDeconstructorPattern

public R visitDeconstructorPattern(DeconstructorPatternNode n,
 P p)

Description copied from interface: NodeVisitor

Visits a deconstructor pattern node.

Specified by:

visitDeconstructorPattern in interface NodeVisitor<R,P>

Parameters:

n - the DeconstructorPatternNode to be visited

p - the argument for the operation implemented by this visitor

Returns:

the return value of the operation implemented by this visitor

visitAnyPattern

public R visitAnyPattern(AnyPatternNode n,
 P p)

Description copied from interface: NodeVisitor

Visits an any pattern node.

Specified by:

visitAnyPattern in interface NodeVisitor<R,P>

Parameters:

n - the AnyPatternNode to be visited

p - the argument for the operation implemented by this visitor

Returns:

the return value of the operation implemented by this visitor