gololang.ir

Class Union

java.lang.Object

gololang.ir.GoloElement<T>

gololang.ir.GoloType<Union>

gololang.ir.Union

All Implemented Interfaces:

ToplevelGoloElement

public final class Union
extends GoloType<Union>
implements ToplevelGoloElement

Represents a union element.

For instance:

 union ConsList = {
   Empty
   Cons = {head, tail}
 }
 

Method Summary

Modifier and Type	Method and Description
void	accept(GoloIrVisitor visitor) Accept the visitor.
boolean	addElement(GoloElement<?> elt) Adds a value or a macro invocation according to the given argument.
boolean	addMacroInvocation(MacroInvocation macroCall) Adds a macro invocation to this union.
boolean	addValue(UnionValue value) Adds a new value to this union.
java.util.List<GoloElement<?>>	children() Returns a list of all the direct children of this node.
java.util.Collection<UnionValue>	getValues()
protected void	replaceElement(GoloElement<?> original, GoloElement<?> newElement) Replace a child.
protected Union	self()
static Union	union(java.lang.String name) Creates a union type.
Union	value(java.lang.String name, java.lang.Object... members) Adds a new value to this union.

Methods inherited from class gololang.ir.GoloType

getName, getPackageAndClass

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

Method Detail

union

public static Union union(java.lang.String name)

Creates a union type.

Typical usage:

 union("ConsList")
   .value("Empty")
   .value("Cons",
      "head",
      "tail")
 

creates

 union ConsList = {
   Empty
   Cons = {head, tail}
 }
 

Parameters:

name - the name of the union.

self

protected Union self()

Specified by:

self in class GoloElement<Union>

addValue

public boolean addValue(UnionValue value)

Adds a new value to this union.

addMacroInvocation

public boolean addMacroInvocation(MacroInvocation macroCall)

Adds a macro invocation to this union.

The macro is supposed to return a UnionValue when expanded. This allows decorator-like syntax on union values:

 union Foo = {
   @someMacro
   Value = {a, b}

   @otherMacro
   OtherValue
 }
 

addElement

public boolean addElement(GoloElement<?> elt)

Adds a value or a macro invocation according to the given argument.

See Also:

addValue(UnionValue), addMacroInvocation(MacroInvocation)

getValues

public java.util.Collection<UnionValue> getValues()

value

public Union value(java.lang.String name,
                   java.lang.Object... members)

Adds a new value to this union.

Convenient fluent method to add a new value.

This is a builder method.

See Also:

addValue(UnionValue), TypeWithMembers.members(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<Union>

children

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

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

Overrides:

children in class GoloElement<Union>

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

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)