gololang.ir

Class GoloAssignment<T extends GoloAssignment<T>>

java.lang.Object

gololang.ir.GoloElement<T>

gololang.ir.GoloStatement<T>

gololang.ir.GoloAssignment<T>

All Implemented Interfaces:

ReferencesHolder

Direct Known Subclasses:

AssignmentStatement, DestructuringAssignment

public abstract class GoloAssignment<T extends GoloAssignment<T>>
extends GoloStatement<T>
implements ReferencesHolder

Method Summary

Modifier and Type	Method and Description
T	as(java.lang.Object expr) Defines the value to be assigned.
java.util.List<GoloElement<?>>	children() Returns a list of all the direct children of this node.
T	declaring() Makes this assignment a declaring one.
T	declaring(boolean isDeclaring) Defines if this assignment is a declaring one.
ExpressionStatement<?>	expression()
LocalReference[]	getDeclaringReferences() Returns only the declaring references.
abstract boolean	isConstant() Checks if this assignment is constant.
boolean	isDeclaring() Checks if this assignment is a declaring one.
protected void	replaceElement(GoloElement<?> original, GoloElement<?> newElement) Replace a child.
abstract T	to(java.lang.Object... refs) Defines the references to which assign the expression.
abstract T	variable() Makes this assignment variable.

Methods inherited from class gololang.ir.GoloStatement

of

Methods inherited from class gololang.ir.GoloElement

accept, ancestor, ancestor, ancestorOfType, cantConvert, cantReplace, cantReplace, children, children, descendants, descendants, descendants, documentation, documentation, doesNotContain, enclosingModule, getLocalReferenceTable, hasParent, hasPosition, inheritedMetadata, makeParentOf, metadata, metadata, next, next, next, ofAST, parent, positionInSourceCode, positionInSourceCode, previous, previous, previous, replaceInParentBy, self, 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.ReferencesHolder

getReferences, getReferencesCount

Method Detail

isDeclaring

public final boolean isDeclaring()

Checks if this assignment is a declaring one.

See Also:

declaring()

declaring

public final T declaring(boolean isDeclaring)

Defines if this assignment is a declaring one. A declaring assignment is one that first defines the value of a reference, that is a let or var assignment. An assignment to a previously defined mutable variable (one declared with var) is not a declaring assignment.

This is a builder method.

Parameters:

isDeclaring - whether the assignment is declaring.

Returns:

this assignment

declaring

public final T declaring()

Makes this assignment a declaring one.

Same as declaring(true).

Returns:

this assignment

variable

public abstract T variable()

Makes this assignment variable.

See Also:

LocalReference.variable()

isConstant

public abstract boolean isConstant()

Checks if this assignment is constant.

See Also:

LocalReference.isConstant()

expression

public final ExpressionStatement<?> expression()

as

public final T as(java.lang.Object expr)

Defines the value to be assigned.

This is a builder method.

Parameters:

expr - the ExpressionStatement to assign or an object that can be converted into an expression

Returns:

this assignment

See Also:

ExpressionStatement.of(Object)

to

public abstract T 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")
 

Parameters:

refs - the LocalReferences to assign to

Returns:

this assignment

getDeclaringReferences

public LocalReference[] getDeclaringReferences()

Returns only the declaring references.

Specified by:

getDeclaringReferences in interface ReferencesHolder

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<T extends GoloAssignment<T>>

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)

children

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

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

Overrides:

children in class GoloElement<T extends GoloAssignment<T>>