gololang.ir

Class ForEachLoopStatement

java.lang.Object

gololang.ir.GoloElement<T>

gololang.ir.GoloStatement<ForEachLoopStatement>

gololang.ir.ForEachLoopStatement

All Implemented Interfaces:

BlockContainer<ForEachLoopStatement>, ReferencesHolder

public final class ForEachLoopStatement
extends GoloStatement<ForEachLoopStatement>
implements BlockContainer<ForEachLoopStatement>, ReferencesHolder

Represents a foreach loop on an iterator.

For instance:

 foreach x in range(5) {
   println(x)
 }
 

Method Summary

Modifier and Type	Method and Description
void	accept(GoloIrVisitor visitor) Accept the visitor.
ForEachLoopStatement	block(java.lang.Object block) Defines the contained block.
java.util.List<GoloElement<?>>	children() Returns a list of all the direct children of this node.
static ForEachLoopStatement	create()
static ForEachLoopStatement	create(boolean varargs, java.lang.Object iterable, java.lang.Object when, java.lang.Object block, java.lang.Object... vars) Complete foreach loop.
Block	getBlock()
ExpressionStatement<?>	getIterable()
LocalReference	getLocalReference()
LocalReference[]	getReferences() Returns the references contained in this element.
int	getReferencesCount() Returns the number of references contained in this element.
ExpressionStatement<?>	getWhenClause()
boolean	hasWhenClause()
ForEachLoopStatement	in(java.lang.Object iterable) Defines the iterable on which to loop.
boolean	isDestructuring()
boolean	isVarargs()
protected void	replaceElement(GoloElement<?> original, GoloElement<?> newElement) Replace a child.
protected ForEachLoopStatement	self()
ForEachLoopStatement	var(java.lang.Object varRef) Adds a loop variable.
ForEachLoopStatement	varargs(boolean b)
ForEachLoopStatement	when(java.lang.Object clause) Adds a when clause to the loop.

Methods inherited from class gololang.ir.GoloStatement

of

Methods inherited from class gololang.ir.GoloElement

ancestor, ancestor, ancestorOfType, cantConvert, cantReplace, cantReplace, children, children, descendants, descendants, descendants, documentation, documentation, doesNotContain, enclosingModule, getLocalReferenceTable, hasParent, hasPosition, makeParentOf, metadata, metadata, next, next, next, ofAST, parent, positionInSourceCode, positionInSourceCode, previous, previous, previous, replaceInParentBy, walk

Methods inherited from class java.lang.Object

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

Methods inherited from interface gololang.ir.BlockContainer

body

Methods inherited from interface gololang.ir.ReferencesHolder

getDeclaringReferences

Method Detail

create

public static ForEachLoopStatement create(boolean varargs,
                                          java.lang.Object iterable,
                                          java.lang.Object when,
                                          java.lang.Object block,
                                          java.lang.Object... vars)

Complete foreach loop. For meta-generation.

Parameters:

varargs - the parameters of the loop are variable length destructuring

iterable - the iterable we loop on

when - the loop filter

block - the loop block

vars - the loop variables

create

public static ForEachLoopStatement create()

block

public ForEachLoopStatement block(java.lang.Object block)

Defines the contained block.

This is a builder method.

Specified by:

block in interface BlockContainer<ForEachLoopStatement>

Parameters:

block - an object that can be converted into a Block

See Also:

Block.of(Object)

self

protected ForEachLoopStatement self()

Specified by:

self in class GoloElement<ForEachLoopStatement>

in

public ForEachLoopStatement in(java.lang.Object iterable)

Defines the iterable on which to loop.

This is a builder method.

Parameters:

iterable - an ExpressionStatement representing an Iterable expression.

varargs

public ForEachLoopStatement varargs(boolean b)

var

public ForEachLoopStatement var(java.lang.Object varRef)

Adds a loop variable.

This is a builder method.

Parameters:

varRef - the variable (a LocalReference create)

See Also:

LocalReference.of(Object)

when

public ForEachLoopStatement when(java.lang.Object clause)

Adds a when clause to the loop.

This is a builder method.

Parameters:

clause - an ExpressionStatement used as a condition.

getIterable

public ExpressionStatement<?> getIterable()

getBlock

public Block getBlock()

Specified by:

getBlock in interface BlockContainer<ForEachLoopStatement>

isDestructuring

public boolean isDestructuring()

isVarargs

public boolean isVarargs()

getLocalReference

public LocalReference getLocalReference()

getReferences

public LocalReference[] getReferences()

Returns the references contained in this element.

Specified by:

getReferences in interface ReferencesHolder

getReferencesCount

public int getReferencesCount()

Returns the number of references contained in this element.

Specified by:

getReferencesCount in interface ReferencesHolder

hasWhenClause

public boolean hasWhenClause()

getWhenClause

public ExpressionStatement<?> getWhenClause()

accept

public void accept(GoloIrVisitor visitor)

Accept the visitor.

This method should only call the visitor visitXXXX method. The children of this node will be visited by the GoloElement.walk(GoloIrVisitor) method.

Specified by:

accept in class GoloElement<ForEachLoopStatement>

children

public java.util.List<GoloElement<?>> children()

Returns a list of all the direct children of this node.

Overrides:

children in class GoloElement<ForEachLoopStatement>

replaceElement

protected void replaceElement(GoloElement<?> original,
                              GoloElement<?> newElement)

Replace a child.

Replace original with newElement if original is a child of this node and type matches.

Specified by:

replaceElement in class GoloElement<ForEachLoopStatement>

Parameters:

original - the original value to replace. Must be a child of this node

newElement - the element to replace with. Type must match.

See Also:

GoloElement.cantReplace(), GoloElement.cantReplace(GoloElement, GoloElement), GoloElement.doesNotContain(GoloElement), GoloElement.cantConvert(String, Object)