Package org.checkerframework.dataflow.cfg.node

Class ArrayAccessNode

java.lang.Object

org.checkerframework.dataflow.cfg.node.Node

org.checkerframework.dataflow.cfg.node.ArrayAccessNode

All Implemented Interfaces:

org.plumelib.util.UniqueId

public class ArrayAccessNode
extends Node

A node for an array access:

   arrayref [ index ]
 

We allow array accesses without corresponding AST Trees.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Node	array	The array expression being accessed.
protected @Nullable ExpressionTree	arrayExpression	If this ArrayAccessNode is a node for an array desugared from an enhanced for loop, then the arrayExpression field is the expression in the for loop, e.g., arr in for(Object o: arr.
protected @Nullable EnhancedForLoopTree	enhancedForLoop	If this ArrayAccessNode is a node for an array access desugared from an enhanced for loop, then the enhancedForLoop field is the EnhancedForLoopTree AST node.
protected final Node	index	The index expresssion used to access the array.
protected final ArrayAccessTree	tree	The corresponding ArrayAccessTree.

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

block, disambiguateOwner, inSource, lvalue, type

Constructor Summary

Constructors

Constructor	Description
ArrayAccessNode(ArrayAccessTree t, Node array, Node index)	Create an ArrayAccessNode.

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 Object obj)
Node	getArray()	Returns the node that represents the array expression being accessed.
@Nullable ExpressionTree	getArrayExpression()	If this ArrayAccessNode is a node for an array desugared from an enhanced for loop, then return the expression in the for loop, e.g., arr in for(Object o: arr.
@Nullable EnhancedForLoopTree	getEnhancedForLoop()	If this ArrayAccessNode is a node for an array access desugared from an enhanced for loop, then return the EnhancedForLoopTree AST node.
Node	getIndex()
Collection<Node>	getOperands()	Returns a collection containing all of the operand Nodes of this Node.
ArrayAccessTree	getTree()	Returns the Tree in the abstract syntax tree, or null if no corresponding tree exists.
int	hashCode()
void	setArrayExpression(@Nullable ExpressionTree arrayExpression)	Set the array expression from a for loop.
void	setEnhancedForLoop(@Nullable EnhancedForLoopTree enhancedForLoop)	Set the enhanced for loop from which this is desugared from.
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 Details

tree

protected final ArrayAccessTree tree

The corresponding ArrayAccessTree.

array

protected final Node array

The array expression being accessed.

index

protected final Node index

The index expresssion used to access the array.

arrayExpression

protected @Nullable ExpressionTree arrayExpression

If this ArrayAccessNode is a node for an array desugared from an enhanced for loop, then the arrayExpression field is the expression in the for loop, e.g., arr in for(Object o: arr.

Is set by setArrayExpression(com.sun.source.tree.ExpressionTree).

enhancedForLoop

protected @Nullable EnhancedForLoopTree enhancedForLoop

If this ArrayAccessNode is a node for an array access desugared from an enhanced for loop, then the enhancedForLoop field is the EnhancedForLoopTree AST node.

Is set by setEnhancedForLoop(com.sun.source.tree.EnhancedForLoopTree).

Constructor Details

ArrayAccessNode

public ArrayAccessNode(ArrayAccessTree t,
 Node array,
 Node index)

Create an ArrayAccessNode.

Parameters:

t - tree for the array access

array - the node for the array expression being accessed

index - the node for the index used to access the array

Method Details

getArrayExpression

public @Nullable ExpressionTree getArrayExpression()

If this ArrayAccessNode is a node for an array desugared from an enhanced for loop, then return the expression in the for loop, e.g., arr in for(Object o: arr. Otherwise, return null.

Returns:

the array expression, or null if this is not an array desugared from an enhanced for loop

setArrayExpression

public void setArrayExpression(@Nullable ExpressionTree arrayExpression)

Set the array expression from a for loop.

Parameters:

arrayExpression - array expression

See Also:

• getArrayExpression()

getEnhancedForLoop

public @Nullable EnhancedForLoopTree getEnhancedForLoop()

If this ArrayAccessNode is a node for an array access desugared from an enhanced for loop, then return the EnhancedForLoopTree AST node. Otherwise, return null.

Returns:

the EnhancedForLoopTree, or null if this is not an array access desugared from an enhanced for loop

setEnhancedForLoop

public void setEnhancedForLoop(@Nullable EnhancedForLoopTree enhancedForLoop)

Set the enhanced for loop from which this is desugared from.

Parameters:

enhancedForLoop - the EnhancedForLoopTree

See Also:

• getEnhancedForLoop()

getArray

public Node getArray()

Returns the node that represents the array expression being accessed.

Returns:

the array expression node

getIndex

public Node getIndex()

getTree

public ArrayAccessTree 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

@SideEffectFree
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