gololang.ir

Class ToplevelElements

java.lang.Object

gololang.ir.GoloElement<ToplevelElements>

gololang.ir.ToplevelElements

All Implemented Interfaces:

java.lang.Iterable<GoloElement<?>>

public final class ToplevelElements
extends GoloElement<ToplevelElements>
implements java.lang.Iterable<GoloElement<?>>

A container of top-level GoloElement.

This class is mainly used by top-level macros to return a collection of golo top-level elements, i.e. functions, structs, augments and so on, since a macro must return a unique GoloElement to inject in the Ir by replacing the macro call.

This element must never be present in a tree.

Method Summary

Modifier and Type	Method and Description
void	accept(GoloIrVisitor visitor) Accept the visitor.
ToplevelElements	add(java.lang.Object element)
java.util.List<GoloElement<?>>	children() Returns a list of all the direct children of this node.
static ToplevelElements	fromIterable(java.lang.Iterable<java.lang.Object> elements) Creates a top-level elements container.
boolean	isEmpty()
java.util.Iterator<GoloElement<?>>	iterator()
ToplevelElements	map(FunctionReference fun) Map a golo function on the contained elements.
static ToplevelElements	of(java.lang.Object... elements) Creates a top-level elements container.
void	replaceElement(GoloElement<?> original, GoloElement<?> newElement) Replace a child.
protected ToplevelElements	self()

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, inheritedMetadata, 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 java.lang.Iterable

forEach, spliterator

Method Detail

of

public static ToplevelElements of(java.lang.Object... elements)

Creates a top-level elements container.

Mainly used to return several nodes from a top-level macro.

If only a ToplevelElements instance is given, it is returned unchanged.

Parameters:

elements - the Golo Elements to add.

Returns:

a ToplevelElements containing all the given elements.

fromIterable

public static ToplevelElements fromIterable(java.lang.Iterable<java.lang.Object> elements)

Creates a top-level elements container.

Mainly used to return several nodes from a top-level macro.

self

protected ToplevelElements self()

Specified by:

self in class GoloElement<ToplevelElements>

add

public ToplevelElements add(java.lang.Object element)

isEmpty

public boolean isEmpty()

map

public ToplevelElements map(FunctionReference fun)
                     throws java.lang.Throwable

Map a golo function on the contained elements.

This can be used in top-level macros to apply the macro on a top-level from a previous macro application, for instance when stacking decorator-like macros returning a ToplevelElements.

Throws:

java.lang.Throwable

iterator

public java.util.Iterator<GoloElement<?>> iterator()

Specified by:

iterator in interface java.lang.Iterable<GoloElement<?>>

children

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

Description copied from class: GoloElement

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

Overrides:

children in class GoloElement<ToplevelElements>

replaceElement

public void replaceElement(GoloElement<?> original,
                           GoloElement<?> newElement)

Description copied from class: GoloElement

Replace a child.

Replace original with newElement if original is a child of this node and type matches.

Specified by:

replaceElement in class GoloElement<ToplevelElements>

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)

accept

public void accept(GoloIrVisitor visitor)

Description copied from class: GoloElement

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