gololang.ir

Class DestructuringAssignment

java.lang.Object

gololang.ir.GoloElement<T>

gololang.ir.GoloStatement<T>

gololang.ir.GoloAssignment<DestructuringAssignment>

gololang.ir.DestructuringAssignment

All Implemented Interfaces:

ReferencesHolder

public final class DestructuringAssignment
extends GoloAssignment<DestructuringAssignment>

A destructuring assignment.

For instance:

 let a, b = [1, 2]
 

Method Summary

Modifier and Type	Method and Description
void	accept(GoloIrVisitor visitor) Accept the visitor.
static DestructuringAssignment	create() Creates a uninitialized destructuring assignment.
static DestructuringAssignment	destruct(java.lang.Object expr) Create a destructuring assignment.
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.
boolean	isVarargs() Checks if this destructuring is a varargs one.
protected DestructuringAssignment	self()
DestructuringAssignment	to(java.lang.Object... refs) Defines the references to which assign the expression.
java.lang.String	toString()
DestructuringAssignment	varargs() Defines this destructuring as a varargs one.
DestructuringAssignment	varargs(boolean varargs) Defines if this destructuring is a varargs one.
DestructuringAssignment	variable() Makes this assignment variable.
void	walk(GoloIrVisitor visitor) Walk the visitor through this node children.

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

Methods inherited from class java.lang.Object

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

Method Detail

destruct

public static DestructuringAssignment destruct(java.lang.Object expr)

Create a destructuring assignment.

Typical usage:

 destruct(tuple(1, 2)).to("a", "b").declaring(true)
 

creates

 let a, b = [1, 2]
 

Parameters:

expr - the expression to destructure

See Also:

GoloAssignment.as(Object)

create

public static DestructuringAssignment create()

Creates a uninitialized destructuring assignment.

self

protected DestructuringAssignment self()

Specified by:

self in class GoloElement<DestructuringAssignment>

isVarargs

public boolean isVarargs()

Checks if this destructuring is a varargs one.

See Also:

varargs(boolean)

varargs

public DestructuringAssignment varargs(boolean varargs)

Defines if this destructuring is a varargs one.

For instance:

 let a, b... = list[1, 2, 3, 4]
 

This is a builder method.

varargs

public DestructuringAssignment varargs()

Defines this destructuring as a varargs one.

Same as varargs(true).

variable

public DestructuringAssignment variable()

Makes this assignment variable.

Specified by:

variable in class GoloAssignment<DestructuringAssignment>

See Also:

LocalReference.variable()

isConstant

public boolean isConstant()

Checks if this assignment is constant.

Specified by:

isConstant in class GoloAssignment<DestructuringAssignment>

See Also:

LocalReference.isConstant()

getReferences

public LocalReference[] getReferences()

Returns the references contained in this element.

getReferencesCount

public int getReferencesCount()

Returns the number of references contained in this element.

to

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

Description copied from class: GoloAssignment

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

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

walk

public void walk(GoloIrVisitor visitor)

Walk the visitor through this node children.

Overrides:

walk in class GoloElement<DestructuringAssignment>