Package com.tonic.analysis.source.ast.stmt

Class ForEachStmt

java.lang.Object

com.tonic.analysis.source.ast.stmt.ForEachStmt

All Implemented Interfaces:

ASTNode, Statement

public final class ForEachStmt
extends Object
implements Statement

An enhanced for loop over an iterable or array, with an optional label.

Constructor Summary

Constructors

Constructor	Description
ForEachStmt(VarDeclStmt variable, Expression iterable, Statement body)	Creates an unlabeled enhanced for loop with an unknown location.
ForEachStmt(VarDeclStmt variable, Expression iterable, Statement body, String label, SourceLocation location)	Creates an enhanced for loop and parents its children to it.

Method Summary

Modifier and Type	Method	Description
<T> T	accept(SourceVisitor<T> visitor)	Accepts a visitor for this node.
Statement	getBody()
List<ASTNode>	getChildren()	Lists the direct children a node holds, in source order.
Expression	getIterable()
String	getLabel()	Gets the label for this statement, if any.
SourceLocation	getLocation()	Gets the source location of this node.
ASTNode	getParent()	Gets the parent node in the AST tree.
VarDeclStmt	getVariable()
void	setBody(Statement body)	Replaces the loop body, reparenting old and new nodes.
void	setIterable(Expression iterable)	Replaces the iterated expression, reparenting old and new nodes.
void	setLabel(String label)	Sets the label used by labeled break and continue targeting this loop.
void	setLocation(SourceLocation location)	Sets this statement's source location.
void	setParent(ASTNode parent)	Sets the enclosing AST node.
void	setVariable(VarDeclStmt variable)	Replaces the loop variable declaration, reparenting old and new nodes.
String	toString()
ForEachStmt	withBody(Statement body)	Replaces the loop body, reparenting old and new nodes.
ForEachStmt	withIterable(Expression iterable)	Replaces the iterated expression, reparenting old and new nodes.
ForEachStmt	withLabel(String label)	Sets the loop label.
ForEachStmt	withVariable(VarDeclStmt variable)	Replaces the loop variable declaration, reparenting old and new nodes.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.tonic.analysis.source.ast.ASTNode

deepClone, findAll, findAll, findAncestor, findFirst, findFirst, getRoot, isDescendantOf, remove, replaceWith, stream, stream, walk

Constructor Detail

ForEachStmt

public ForEachStmt(VarDeclStmt variable,
                   Expression iterable,
                   Statement body,
                   String label,
                   SourceLocation location)

Creates an enhanced for loop and parents its children to it.

Parameters:

variable - declaration of the loop variable

iterable - the iterated expression

body - the loop body

label - loop label, or null for none

location - source location, or null for unknown

Throws:

NullPointerException - if variable, iterable, or body is null

ForEachStmt

public ForEachStmt(VarDeclStmt variable,
                   Expression iterable,
                   Statement body)

Creates an unlabeled enhanced for loop with an unknown location.

Parameters:

variable - declaration of the loop variable

iterable - the iterated expression

body - the loop body

Throws:

NullPointerException - if variable, iterable, or body is null

Method Detail

getVariable

public VarDeclStmt getVariable()

Returns:

the variable

setVariable

public void setVariable(VarDeclStmt variable)

Replaces the loop variable declaration, reparenting old and new nodes.

Parameters:

variable - the new loop variable declaration

getIterable

public Expression getIterable()

Returns:

the iterable

setIterable

public void setIterable(Expression iterable)

Replaces the iterated expression, reparenting old and new nodes.

Parameters:

iterable - the new iterated expression

getBody

public Statement getBody()

Returns:

the loop body

setBody

public void setBody(Statement body)

Replaces the loop body, reparenting old and new nodes.

Parameters:

body - the new body

setLabel

public void setLabel(String label)

Sets the label used by labeled break and continue targeting this loop.

Parameters:

label - the label, or null to remove it

getLocation

public SourceLocation getLocation()

Description copied from interface: ASTNode

Gets the source location of this node.

Specified by:

getLocation in interface ASTNode

Returns:

the location

getParent

public ASTNode getParent()

Description copied from interface: ASTNode

Gets the parent node in the AST tree.

Specified by:

getParent in interface ASTNode

Returns:

the parent

setParent

public void setParent(ASTNode parent)

Sets the enclosing AST node.

Specified by:

setParent in interface ASTNode

Parameters:

parent - the new parent node

getLabel

public String getLabel()

Description copied from interface: Statement

Gets the label for this statement, if any.

Specified by:

getLabel in interface Statement

Returns:

the label, or null if not labeled

withVariable

public ForEachStmt withVariable(VarDeclStmt variable)

Replaces the loop variable declaration, reparenting old and new nodes.

Parameters:

variable - the new loop variable declaration

Returns:

this statement

withIterable

public ForEachStmt withIterable(Expression iterable)

Replaces the iterated expression, reparenting old and new nodes.

Parameters:

iterable - the new iterated expression

Returns:

this statement

withBody

public ForEachStmt withBody(Statement body)

Replaces the loop body, reparenting old and new nodes.

Parameters:

body - the new body

Returns:

this statement

withLabel

public ForEachStmt withLabel(String label)

Sets the loop label.

Parameters:

label - the new label, or null for none

Returns:

this statement

getChildren

public List<ASTNode> getChildren()

Description copied from interface: ASTNode

Lists the direct children a node holds, in source order.

Specified by:

getChildren in interface ASTNode

Returns:

the direct children, empty for a leaf

accept

public <T> T accept(SourceVisitor<T> visitor)

Description copied from interface: ASTNode

Accepts a visitor for this node.

Specified by:

accept in interface ASTNode

Type Parameters:

T - the return type of the visitor

Parameters:

visitor - the visitor to accept

Returns:

the result from the visitor

toString

public String toString()

Overrides:

toString in class Object

setLocation

public void setLocation(SourceLocation location)

Description copied from interface: Statement

Sets this statement's source location.

Specified by:

setLocation in interface Statement

Parameters:

location - the provenance to stamp, or null for SourceLocation.UNKNOWN