gololang.ir

Class LoopStatement

java.lang.Object

gololang.ir.GoloElement<T>

gololang.ir.GoloStatement<LoopStatement>

gololang.ir.LoopStatement

All Implemented Interfaces:

BlockContainer<LoopStatement>, ReferencesHolder

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

Generic looping structure.

This is used to represent both for and while loops, as well as the desugared foreach loop.

Method Summary

Modifier and Type	Method and Description
void	accept(GoloIrVisitor visitor) Accept the visitor.
LoopStatement	block(java.lang.Object innerBlock) Defines the contained block.
java.util.List<GoloElement<?>>	children() Returns a list of all the direct children of this node.
ExpressionStatement<?>	condition()
LoopStatement	condition(java.lang.Object expression) Defines the loop condition.
static LoopStatement	create(java.lang.Object init, java.lang.Object condition, java.lang.Object post, java.lang.Object block) Complete loop creation.
Block	getBlock()
LocalReference[]	getReferences() Returns the references contained in this element.
int	getReferencesCount() Returns the number of references contained in this element.
boolean	hasInitStatement()
boolean	hasPostStatement()
AssignmentStatement	init()
LoopStatement	init(java.lang.Object assignment) Defines the initialization of the loop variable.
static LoopStatement	loop() Creates a generic loop.
GoloStatement<?>	post()
LoopStatement	post(java.lang.Object statement) Define the post-loop statement.
protected void	replaceElement(GoloElement<?> original, GoloElement<?> newElement) Replace a child.
protected LoopStatement	self()

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

loop

public static LoopStatement loop()

Creates a generic loop.

create

public static LoopStatement create(java.lang.Object init,
                                   java.lang.Object condition,
                                   java.lang.Object post,
                                   java.lang.Object block)

Complete loop creation. For meta-generation.

self

protected LoopStatement self()

Specified by:

self in class GoloElement<LoopStatement>

init

public LoopStatement init(java.lang.Object assignment)

Defines the initialization of the loop variable.

For instance, the var i = 0 statement. This can be null in the case of while loops.

This is a builder method.

Parameters:

assignment - a AssignmentStatement defining the loop variable.

condition

public LoopStatement condition(java.lang.Object expression)

Defines the loop condition.

For instance, the i < 10 expression.

This is a builder method.

Parameters:

expression - a ExpressionStatement evaluating to a boolean.

post

public LoopStatement post(java.lang.Object statement)

Define the post-loop statement.

For instance, the i = i + 1 statement. This can be null in the case of while loops.

This is a builder method.

Parameters:

statement - a GoloStatement changing the loop variable.

block

public LoopStatement block(java.lang.Object innerBlock)

Defines the contained block.

This is a builder method.

Specified by:

block in interface BlockContainer<LoopStatement>

Parameters:

innerBlock - an object that can be converted into a Block

See Also:

Block.of(Object)

hasInitStatement

public boolean hasInitStatement()

init

public AssignmentStatement init()

condition

public ExpressionStatement<?> condition()

getBlock

public Block getBlock()

Specified by:

getBlock in interface BlockContainer<LoopStatement>

post

public GoloStatement<?> post()

hasPostStatement

public boolean hasPostStatement()

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

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<LoopStatement>

children

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

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

Overrides:

children in class GoloElement<LoopStatement>

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<LoopStatement>

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)