gololang.ir

Class AssignmentStatement

java.lang.Object

gololang.ir.GoloElement<T>

gololang.ir.GoloStatement<T>

gololang.ir.GoloAssignment<AssignmentStatement>

gololang.ir.AssignmentStatement

All Implemented Interfaces:

ReferencesHolder, ToplevelGoloElement

public final class AssignmentStatement
extends GoloAssignment<AssignmentStatement>
implements ToplevelGoloElement

Assignment statement in Golo code.

An assignment is a statement like:

 var foo = 42
 let bar = a(more: complex()) + expression
 

Method Summary

Modifier and Type	Method and Description
void	accept(GoloIrVisitor visitor) Accept the visitor.
static AssignmentStatement	create() Creates a uninitialized assignment.
static AssignmentStatement	create(java.lang.Object ref, java.lang.Object value, java.lang.Object declaring) Full assignment creation in one call.
LocalReference	getLocalReference()
LocalReference[]	getReferences() Returns the references contained in this element.
int	getReferencesCount() Returns the number of references contained in this element.
boolean	isConstant() Checks if this assignment is constant.
protected AssignmentStatement	self()
AssignmentStatement	to(java.lang.Object... refs) Defines the references to which assign the expression.
java.lang.String	toString()
AssignmentStatement	variable() Makes this assignment variable.

Methods inherited from class gololang.ir.GoloAssignment

as, children, declaring, declaring, expression, getDeclaringReferences, isDeclaring, replaceElement

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

create

public static AssignmentStatement create(java.lang.Object ref,
                                         java.lang.Object value,
                                         java.lang.Object declaring)

Full assignment creation in one call.

A lot less readable than the fluent API, but useful when doing meta-generation

Parameters:

ref - the reference to assign to (to(Object...)).

value - the value to assign (GoloAssignment.as(Object)).

declaring - whether the assignment is a declaring one.

Returns:

an initialized assignment element.

create

public static AssignmentStatement create()

Creates a uninitialized assignment.

self

protected AssignmentStatement self()

Specified by:

self in class GoloElement<AssignmentStatement>

getLocalReference

public LocalReference getLocalReference()

variable

public AssignmentStatement variable()

Makes this assignment variable.

Specified by:

variable in class GoloAssignment<AssignmentStatement>

See Also:

LocalReference.variable()

isConstant

public boolean isConstant()

Checks if this assignment is constant.

Specified by:

isConstant in class GoloAssignment<AssignmentStatement>

See Also:

LocalReference.isConstant()

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

to

public AssignmentStatement to(java.lang.Object... refs)

Defines the references to which assign the expression.

This is a builder method.

For instance, code like:

  foo = 42
 

can be generated by:

 assign(constant(42)).to(localRef("foo"))
 

or using implicit conversions:

 assign(42).to("foo")
 

Specified by:

to in class GoloAssignment<AssignmentStatement>

Parameters:

refs - the LocalReferences to assign to

Returns:

this assignment

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