gololang.ir

Class ConditionalBranching

java.lang.Object

gololang.ir.GoloElement<T>

gololang.ir.GoloStatement<ConditionalBranching>

gololang.ir.ConditionalBranching

public final class ConditionalBranching
extends GoloStatement<ConditionalBranching>

Represents a conditional branching.

Typically an if else node.

Method Summary

Modifier and Type	Method and Description
void	accept(GoloIrVisitor visitor) Accept the visitor.
static ConditionalBranching	branch() Creates an empty conditional branch.
java.util.List<GoloElement<?>>	children() Returns a list of all the direct children of this node.
ConditionalBranching	condition(java.lang.Object cond) Defines the condition of the branching.
static ConditionalBranching	create(java.lang.Object condition, java.lang.Object trueBlock, java.lang.Object falseBlock, java.lang.Object elseBranch) Full branch construction in one call.
ConditionalBranching	elseBranch(java.lang.Object elseBranch) Defines a nested conditional branch.
ExpressionStatement<?>	getCondition()
ConditionalBranching	getElseConditionalBranching()
Block	getFalseBlock()
Block	getTrueBlock()
boolean	hasElseConditionalBranching()
boolean	hasFalseBlock()
ConditionalBranching	otherwise(java.lang.Object alternative) Defines a block to execute when false or a nested branch according to the given element.
protected void	replaceElement(GoloElement<?> original, GoloElement<?> newElement) Replace a child.
boolean	returnsFromBothBranches()
protected ConditionalBranching	self()
java.lang.String	toString()
ConditionalBranching	whenFalse(java.lang.Object block) Defines the block executed when the condition evaluates to false.
ConditionalBranching	whenTrue(java.lang.Object block) Defines the block executed when the condition evaluates to true.

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, wait, wait, wait

Method Detail

branch

public static ConditionalBranching branch()

Creates an empty conditional branch.

create

public static ConditionalBranching create(java.lang.Object condition,
                                          java.lang.Object trueBlock,
                                          java.lang.Object falseBlock,
                                          java.lang.Object elseBranch)

Full branch construction in one call.

Less readable than the fluent API, but useful when doing meta-generation

Parameters:

condition - the test condition

trueBlock - the block to execute when the condition is true

falseBlock - the block to execute when the condition is false

elseBranch - a nested conditional branch

self

protected ConditionalBranching self()

Specified by:

self in class GoloElement<ConditionalBranching>

condition

public ConditionalBranching condition(java.lang.Object cond)

Defines the condition of the branching.

This is a builder method.

Parameters:

cond - the expression defining the condition. If null, the condition is set to false.

Returns:

the branching.

whenTrue

public ConditionalBranching whenTrue(java.lang.Object block)

Defines the block executed when the condition evaluates to true.

This is a builder method.

whenFalse

public ConditionalBranching whenFalse(java.lang.Object block)

Defines the block executed when the condition evaluates to false.

This is a builder method.

See Also:

otherwise(Object)

elseBranch

public ConditionalBranching elseBranch(java.lang.Object elseBranch)

Defines a nested conditional branch.

This is a builder method.

This represents an else if branch.

See Also:

otherwise(Object)

otherwise

public ConditionalBranching otherwise(java.lang.Object alternative)

Defines a block to execute when false or a nested branch according to the given element.

This is a builder method; it's the preferred way to define an alternative to the true block.

Parameters:

alternative - a Block to execute when false or a ConditionalBranching defining a nested branch.

getCondition

public ExpressionStatement<?> getCondition()

getTrueBlock

public Block getTrueBlock()

getFalseBlock

public Block getFalseBlock()

hasFalseBlock

public boolean hasFalseBlock()

getElseConditionalBranching

public ConditionalBranching getElseConditionalBranching()

hasElseConditionalBranching

public boolean hasElseConditionalBranching()

returnsFromBothBranches

public boolean returnsFromBothBranches()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

children

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

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

Overrides:

children in class GoloElement<ConditionalBranching>

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

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)