GoloElement (golo 3.4.0 API)

java.lang.Object
- gololang.ir.GoloElement<T>

Direct Known Subclasses:

Augmentation, Decorator, GoloModule, GoloStatement, GoloType, LocalReference, Member, ModuleImport, NamedAugmentation, ToplevelElements, WhenClause
```
public abstract class GoloElement<T extends GoloElement<T>>
extends java.lang.Object
```
Generic IR tree Element.
The IR tree represents a more abstract representation of the Golo code.

Constructor Summary

Constructors
Constructor and Description

GoloElement()

Constructors
Constructor and Description
`GoloElement()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`accept(GoloIrVisitor visitor)` Accept the visitor.
`GoloElement<?>`	`ancestor(FunctionReference predicate)` Returns the first ancestor of this node matching the given predicate.
`GoloElement<?>`	`ancestor(java.util.function.Predicate<GoloElement<?>> predicate)` Returns the first ancestor of this node matching the given predicate.
`<C extends GoloElement<?>> C`	`ancestorOfType(java.lang.Class<C> cls)` Returns the first ancestor of this node being an instance of the given class.
`protected static java.lang.RuntimeException`	`cantConvert(java.lang.String expected, java.lang.Object value)`
`protected java.lang.RuntimeException`	`cantReplace()`
`protected java.lang.RuntimeException`	`cantReplace(GoloElement<?> original, GoloElement<?> replacement)`
`java.util.List<GoloElement<?>>`	`children()` Returns a list of all the direct children of this node.
`java.util.List<GoloElement<?>>`	`children(FunctionReference predicate)` Returns a iterable on the direct children of this node matching the given predicate.
`java.util.List<GoloElement<?>>`	`children(java.util.function.Predicate<GoloElement<?>> predicate)` Returns a list the direct children of this node matching the given predicate.
`java.util.stream.Stream<GoloElement<?>>`	`descendants()`
`java.util.List<GoloElement<?>>`	`descendants(FunctionReference predicate)` Returns a list of all the descendants of this node matching the given predicate.
`java.util.List<GoloElement<?>>`	`descendants(java.util.function.Predicate<GoloElement<?>> predicate)` Returns a list of all the descendants of this node matching the given predicate.
`java.lang.String`	`documentation()`
`T`	`documentation(java.lang.String doc)`
`protected java.lang.RuntimeException`	`doesNotContain(GoloElement<?> element)`
`GoloModule`	`enclosingModule()` Returns the module containing this element.
`java.util.Optional<ReferenceTable>`	`getLocalReferenceTable()`
`boolean`	`hasParent()`
`boolean`	`hasPosition()`
`java.lang.Object`	`inheritedMetadata(java.lang.String name)` Retrieve metadata, searching all element hierarchy.
`protected <C extends GoloElement<?>> C`	`makeParentOf(C childElement)`
`java.lang.Object`	`metadata(java.lang.String name)` Retrieve a previously stored meta-data.
`T`	`metadata(java.lang.String name, java.lang.Object value)` Stores a meta-data in this element.
`GoloElement<?>`	`next()` Returns the next sibling of this element.
`GoloElement<?>`	`next(FunctionReference predicate)` Returns the next sibling of this element matching the given predicate.
`GoloElement<?>`	`next(java.util.function.Predicate<GoloElement<?>> predicate)` Returns the next sibling of this element matching the given predicate.
`T`	`ofAST(GoloASTNode node)` Init the position and documentation from the given AST node.
`GoloElement<?>`	`parent()`
`PositionInSourceCode`	`positionInSourceCode()`
`T`	`positionInSourceCode(PositionInSourceCode pos)`
`GoloElement<?>`	`previous()` Returns the previous sibling of this element.
`GoloElement<?>`	`previous(FunctionReference predicate)` Returns the previous sibling of this element matching the given predicate.
`GoloElement<?>`	`previous(java.util.function.Predicate<GoloElement<?>> predicate)` Returns the previous sibling of this element matching the given predicate.
`protected abstract void`	`replaceElement(GoloElement<?> original, GoloElement<?> newElement)` Replace a child.
`void`	`replaceInParentBy(GoloElement<?> newElement)` Replaces this element by the given one in its parent node.
`protected abstract T`	`self()`
`void`	`walk(GoloIrVisitor visitor)` Walk the visitor through this node children.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GoloElement
```
public GoloElement()
```
- Method Detail
  - self
```
protected abstract T self()
```
  - ofAST
```
public final T ofAST(GoloASTNode node)
```
    Init the position and documentation from the given AST node.
    
    Parameters:
    
    node - the GoloASTNode to reference.
  - hasParent
```
public final boolean hasParent()
```
  - parent
```
public final GoloElement<?> parent()
```
  - enclosingModule
```
public GoloModule enclosingModule()
```
    Returns the module containing this element.
  - ancestorOfType
```
public <C extends GoloElement<?>> C ancestorOfType(java.lang.Class<C> cls)
```
    Returns the first ancestor of this node being an instance of the given class. Note that if the ancestor can be the element itself.
  - ancestor
```
public GoloElement<?> ancestor(java.util.function.Predicate<GoloElement<?>> predicate)
```
    Returns the first ancestor of this node matching the given predicate. Note that if the ancestor can be the element itself.
  - ancestor
```
public GoloElement<?> ancestor(FunctionReference predicate)
```
    Returns the first ancestor of this node matching the given predicate. Note that if the ancestor can be the element itself.
  - descendants
```
public java.util.List<GoloElement<?>> descendants(java.util.function.Predicate<GoloElement<?>> predicate)
```
    Returns a list of all the descendants of this node matching the given predicate.
  - descendants
```
public java.util.List<GoloElement<?>> descendants(FunctionReference predicate)
```
    Returns a list of all the descendants of this node matching the given predicate.
  - descendants
```
public java.util.stream.Stream<GoloElement<?>> descendants()
```
  - children
```
public java.util.List<GoloElement<?>> children()
```
    Returns a list of all the direct children of this node.
  - children
```
public java.util.List<GoloElement<?>> children(java.util.function.Predicate<GoloElement<?>> predicate)
```
    Returns a list the direct children of this node matching the given predicate.
  - children
```
public java.util.List<GoloElement<?>> children(FunctionReference predicate)
```
    Returns a iterable on the direct children of this node matching the given predicate.
  - previous
```
public GoloElement<?> previous()
```
    Returns the previous sibling of this element.
  - previous
```
public GoloElement<?> previous(java.util.function.Predicate<GoloElement<?>> predicate)
```
    Returns the previous sibling of this element matching the given predicate.
  - previous
```
public GoloElement<?> previous(FunctionReference predicate)
```
    Returns the previous sibling of this element matching the given predicate.
  - next
```
public GoloElement<?> next()
```
    Returns the next sibling of this element.
  - next
```
public GoloElement<?> next(FunctionReference predicate)
```
    Returns the next sibling of this element matching the given predicate.
  - next
```
public GoloElement<?> next(java.util.function.Predicate<GoloElement<?>> predicate)
```
    Returns the next sibling of this element matching the given predicate.
  - makeParentOf
```
protected final <C extends GoloElement<?>> C makeParentOf(C childElement)
```
  - metadata
```
public final java.lang.Object metadata(java.lang.String name)
```
    Retrieve a previously stored meta-data.
  - inheritedMetadata
```
public final java.lang.Object inheritedMetadata(java.lang.String name)
```
    Retrieve metadata, searching all element hierarchy.
  - metadata
```
public final T metadata(java.lang.String name,
                        java.lang.Object value)
```
    Stores a meta-data in this element.
    A meta-data can be any object. The main purpose is to allow visitors or macros to store some generic informations in the IR that can be used later by other macros or compilation steps (for instance add some Java annotations to the generated methods).
  - cantReplace
```
protected final java.lang.RuntimeException cantReplace()
```
  - cantReplace
```
protected final java.lang.RuntimeException cantReplace(GoloElement<?> original,
                                                       GoloElement<?> replacement)
```
  - doesNotContain
```
protected final java.lang.RuntimeException doesNotContain(GoloElement<?> element)
```
  - cantConvert
```
protected static final java.lang.RuntimeException cantConvert(java.lang.String expected,
                                                              java.lang.Object value)
```
  - replaceInParentBy
```
public final void replaceInParentBy(GoloElement<?> newElement)
```
    Replaces this element by the given one in its parent node.
    This method is typically used during the sugar and macros expansion stages to replace the element by a desugarized version, or the macro call by its result.
    
    Parameters:
    
    newElement - the element to replace this one with.
    
    Throws:
    
    java.lang.IllegalStateException - if this element has no parent.
  - documentation
```
public final java.lang.String documentation()
```
  - documentation
```
public final T documentation(java.lang.String doc)
```
  - positionInSourceCode
```
public final PositionInSourceCode positionInSourceCode()
```
  - positionInSourceCode
```
public final T positionInSourceCode(PositionInSourceCode pos)
```
  - hasPosition
```
public final boolean hasPosition()
```
  - getLocalReferenceTable
```
public java.util.Optional<ReferenceTable> getLocalReferenceTable()
```
  - accept
```
public abstract 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 walk(GoloIrVisitor) method.
  - walk
```
public void walk(GoloIrVisitor visitor)
```
    Walk the visitor through this node children.
  - replaceElement
```
protected abstract void replaceElement(GoloElement<?> original,
                                       GoloElement<?> newElement)
```
    Replace a child.
    Replace original with newElement if original is a child of this node and type matches.
    
    Parameters:
    
    original - the original value to replace. Must be a child of this node
    
    newElement - the element to replace with. Type must match.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if this node does not support replacement
    
    java.util.NoSuchElementException - if original is not a child of this node
    
    java.lang.ClassCastException - if the type of newElement does not match
    
    See Also:
    
    cantReplace(), cantReplace(GoloElement, GoloElement), doesNotContain(GoloElement), cantConvert(String, Object)

Class GoloElement<T extends GoloElement<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GoloElement

Method Detail

self

ofAST

hasParent

parent

enclosingModule

ancestorOfType

ancestor

ancestor

descendants

descendants

descendants

children

children

children

previous

previous

previous

next

next

next

makeParentOf

metadata

inheritedMetadata

metadata

cantReplace

cantReplace

doesNotContain

cantConvert

replaceInParentBy

documentation

documentation

positionInSourceCode

positionInSourceCode

hasPosition

getLocalReferenceTable

accept

walk

replaceElement