org.checkerframework.dataflow.cfg.node

Class ReturnNode

java.lang.Object

org.checkerframework.dataflow.cfg.node.Node

org.checkerframework.dataflow.cfg.node.ReturnNode

All Implemented Interfaces:

org.plumelib.util.UniqueId

public class ReturnNode
extends Node

A node for a return statement:

   return
   return expression
 

No ReturnNode is created for implicit return statements.

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable Node	result The node of the returned expression.
protected ReturnTree	returnTree The return tree.

Fields inherited from class org.checkerframework.dataflow.cfg.node.Node

block, inSource, lvalue, type

Constructor Summary

Constructors

Constructor and Description
ReturnNode(ReturnTree returnTree, @Nullable Node result, Types types) Creates a node for the given return statement.
ReturnNode(ReturnTree returnTree, @Nullable Node result, Types types, LambdaExpressionTree lambda, com.sun.tools.javac.code.Symbol.MethodSymbol methodSymbol) Deprecated. Use #ReturnNode(ReturnTree, Node, Types, LambdaExpressionTree, MethodSymbol) instead.
ReturnNode(ReturnTree returnTree, @Nullable Node result, Types types, MethodTree methodTree) Deprecated. Use #ReturnNode(ReturnTree, Node, Types, LambdaExpressionTree, MethodSymbol) instead.

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(NodeVisitor<R,P> visitor, P p) Accept method of the visitor pattern.
boolean	equals(@Nullable Object obj)
Collection<Node>	getOperands() Returns a collection containing all of the operand Nodes of this Node.
@Nullable Node	getResult() The result of the return node, null otherwise.
ReturnTree	getTree() Returns the Tree in the abstract syntax tree, or null if no corresponding tree exists.
int	hashCode()
String	toString()

Methods inherited from class org.checkerframework.dataflow.cfg.node.Node

getBlock, getInSource, getTransitiveOperands, getType, getUid, isLValue, nodeCollectionToString, setBlock, setInSource, setLValue, toStringDebug

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.plumelib.util.UniqueId

getClassAndUid

Field Detail

returnTree

protected final ReturnTree returnTree

The return tree.

result

protected final @Nullable Node result

The node of the returned expression.

Constructor Detail

ReturnNode

public ReturnNode(ReturnTree returnTree,
                  @Nullable Node result,
                  Types types)

Creates a node for the given return statement.

Parameters:

returnTree - return tree

result - the returned expression

types - types util

ReturnNode

@Deprecated
public ReturnNode(ReturnTree returnTree,
                              @Nullable Node result,
                              Types types,
                              MethodTree methodTree)

Deprecated. Use #ReturnNode(ReturnTree, Node, Types, LambdaExpressionTree, MethodSymbol) instead.

Creates a node for the given return statement.

Parameters:

returnTree - return tree

result - the returned expression

types - types util

methodTree - method tree

ReturnNode

@Deprecated
public ReturnNode(ReturnTree returnTree,
                              @Nullable Node result,
                              Types types,
                              LambdaExpressionTree lambda,
                              com.sun.tools.javac.code.Symbol.MethodSymbol methodSymbol)

Deprecated. Use #ReturnNode(ReturnTree, Node, Types, LambdaExpressionTree, MethodSymbol) instead.

Creates a node for the given return statement.

Parameters:

returnTree - return tree

result - the returned expression

types - types util

lambda - lambda

methodSymbol - methodSymbol

Method Detail

getResult

public @Nullable Node getResult()

The result of the return node, null otherwise.

getTree

public ReturnTree getTree()

Description copied from class: Node

Returns the Tree in the abstract syntax tree, or null if no corresponding tree exists. For instance, this is the case for an ImplicitThisNode.

Specified by:

getTree in class Node

Returns:

the corresponding Tree or null

accept

public <R,P> R accept(NodeVisitor<R,P> visitor,
                      P p)

Description copied from class: Node

Accept method of the visitor pattern.

Specified by:

accept in class Node

Type Parameters:

R - result type of the operation

P - parameter type

Parameters:

visitor - the visitor to be applied to this node

p - the parameter for this operation

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getOperands

public Collection<Node> getOperands()

Description copied from class: Node

Returns a collection containing all of the operand Nodes of this Node.

Specified by:

getOperands in class Node

Returns:

a collection containing all of the operand Nodes of this Node