Package org.checkerframework.dataflow.cfg.node

Class LocalVariableNode

java.lang.Object

org.checkerframework.dataflow.cfg.node.Node

org.checkerframework.dataflow.cfg.node.LocalVariableNode

All Implemented Interfaces:

org.plumelib.util.UniqueId

public class LocalVariableNode
extends Node

A node for a local variable or a parameter:

   identifier
 

We allow local variable uses introduced by the CFGBuilder without corresponding AST Trees.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable Node	receiver	The receiver node for the local variable, null otherwise.
protected com.sun.source.tree.Tree	tree	The tree for the local variable.

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

block, inSource, lvalue, type

Constructor Summary

Constructors

Constructor	Description
LocalVariableNode(com.sun.source.tree.Tree tree)	Create a new local variable node for the given tree.
LocalVariableNode(com.sun.source.tree.Tree tree, @Nullable Node receiver)	Create a new local variable node for the given tree and receiver.

Method Summary

Modifier and Type	Method	Description
<R,P> R	accept(NodeVisitor<R,P> visitor, P p)	Accept method of the visitor pattern.
boolean	equals(@Nullable java.lang.Object obj)
javax.lang.model.element.VariableElement	getElement()	Returns the element associated with this local variable.
java.lang.String	getName()
java.util.Collection<Node>	getOperands()	Returns a collection containing all of the operand Nodes of this Node.
@Nullable Node	getReceiver()	The receiver node for the local variable, null otherwise.
com.sun.source.tree.Tree	getTree()	Returns the Tree in the abstract syntax tree, or null if no corresponding tree exists.
int	hashCode()
java.lang.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

tree

protected final com.sun.source.tree.Tree tree

The tree for the local variable.

receiver

protected final @Nullable Node receiver

The receiver node for the local variable, null otherwise.

Constructor Detail

LocalVariableNode

public LocalVariableNode(com.sun.source.tree.Tree tree)

Create a new local variable node for the given tree.

Parameters:

tree - the tree for the local variable: a VariableTree or an IdentifierTree

LocalVariableNode

public LocalVariableNode(com.sun.source.tree.Tree tree,
                         @Nullable Node receiver)

Create a new local variable node for the given tree and receiver.

Parameters:

tree - the tree for the local variable: a VariableTree or an IdentifierTree

receiver - the receiver for the local variable, or null if none

Method Detail

getElement

public javax.lang.model.element.VariableElement getElement()

Returns the element associated with this local variable.

Returns:

the element associated with this local variable

getReceiver

public @Nullable Node getReceiver()

The receiver node for the local variable, null otherwise.

getName

public java.lang.String getName()

getTree

public com.sun.source.tree.Tree 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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(@Nullable java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getOperands

@SideEffectFree
public java.util.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