Augmentation (golo 3.4.0 API)

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

All Implemented Interfaces:

FunctionContainer, ToplevelGoloElement, java.lang.Iterable<GoloFunction>
```
public final class Augmentation
extends GoloElement<Augmentation>
implements FunctionContainer, ToplevelGoloElement
```
"classical" augmentation.
Represents all the augmentations applied to a type, i.e. functions and named augmentations applied with the with construct.
This represents code such
```
 augment MyType {
   function foo = |this| -> ...
 }
 
```
or
```
 augment MyType with MyAugmentation
 
```

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(GoloIrVisitor visitor)` Accept the visitor.
`void`	`addFunction(GoloFunction func)` Adds a function to this container.
`void`	`addMacroInvocation(MacroInvocation macroCall)` Adds a macro invocation to this container.
`java.util.List<GoloElement<?>>`	`children()` Returns a list of all the direct children of this node.
`java.util.List<GoloFunction>`	`getFunctions()`
`java.util.Set<java.lang.String>`	`getNames()` Returns the names of the applied named augmentations.
`PackageAndClass`	`getPackageAndClass()`
`PackageAndClass`	`getTarget()` Returns the target type of this augmentation.
`boolean`	`hasFunctions()`
`boolean`	`hasNames()` Checks if named augmentations were applied.
`void`	`merge(Augmentation other)` Merge two augmentations applied to the same target.
`static Augmentation`	`of(java.lang.Object target)` Creates an augmentation on the target name.
`protected void`	`replaceElement(GoloElement<?> original, GoloElement<?> newElement)` Replace a child.
`protected Augmentation`	`self()`
`java.lang.String`	`toString()`
`Augmentation`	`with(java.util.Collection<?> objects)` Define the functions or named augmentations to add to the target.
`Augmentation`	`with(java.lang.Object... objects)` Define the functions or named augmentations to add to the target.

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, wait, wait, wait

Methods inherited from interface gololang.ir.FunctionContainer
addElement, addFunctions, getFunction, iterator

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - self
```
protected Augmentation self()
```
    Specified by:
    
    self in class GoloElement<Augmentation>
  - of
```
public static Augmentation of(java.lang.Object target)
```
    Creates an augmentation on the target name.
    
    Parameters:
    
    target - the name of the target (compatible with PackageAndClass.of(Object))
    
    Returns:
    
    a classical augmentation
    
    See Also:
    
    PackageAndClass.of(Object)
  - getTarget
```
public PackageAndClass getTarget()
```
    Returns the target type of this augmentation.
    Note that since resolution is done at runtime, the target is only referenced by its name (here a PackageAndClass).
  - getPackageAndClass
```
public PackageAndClass getPackageAndClass()
```
    Specified by:
    
    getPackageAndClass in interface FunctionContainer
  - getFunctions
```
public java.util.List<GoloFunction> getFunctions()
```
    Specified by:
    
    getFunctions in interface FunctionContainer
  - addFunction
```
public void addFunction(GoloFunction func)
```
    Adds a function to this container.
    
    Specified by:
    
    addFunction in interface FunctionContainer
  - addMacroInvocation
```
public void addMacroInvocation(MacroInvocation macroCall)
```
    Adds a macro invocation to this container.
    The macro is supposed to return a GoloFunction when expanded.
    
    Specified by:
    
    addMacroInvocation in interface FunctionContainer
  - hasFunctions
```
public boolean hasFunctions()
```
    Specified by:
    
    hasFunctions in interface FunctionContainer
  - getNames
```
public java.util.Set<java.lang.String> getNames()
```
    Returns the names of the applied named augmentations.
  - hasNames
```
public boolean hasNames()
```
    Checks if named augmentations were applied.
  - with
```
public Augmentation with(java.lang.Object... objects)
```
    Define the functions or named augmentations to add to the target.
    The objects to add can be a function or a string representing the name of a named augmentation.
    This is a builder method.
    
    Parameters:
    
    objects - functions or named augmentations to add
    
    Returns:
    
    this augmentation
  - with
```
public Augmentation with(java.util.Collection<?> objects)
```
    Define the functions or named augmentations to add to the target.
    The objects to add can be a function or a string representing the name of a named augmentation.
    This is a builder method.
    
    Parameters:
    
    objects - a collection of functions or named augmentations to add
    
    Returns:
    
    this augmentation
  - merge
```
public void merge(Augmentation other)
```
    Merge two augmentations applied to the same target.
    Warning:the functions contained in the other augmentation being move to this one and not copied, the other augmentation references functions but is no more their parent. Therefore, the other augmentation is not in a consistent state and should be dropped, since no more needed.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - 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<Augmentation>
    
    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)
```
    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<Augmentation>
  - children
```
public java.util.List<GoloElement<?>> children()
```
    Returns a list of all the direct children of this node.
    
    Overrides:
    
    children in class GoloElement<Augmentation>

Class Augmentation

Method Summary

Methods inherited from class gololang.ir.GoloElement

Methods inherited from class java.lang.Object

Methods inherited from interface gololang.ir.FunctionContainer

Methods inherited from interface java.lang.Iterable

Method Detail

self

of

getTarget

getPackageAndClass

getFunctions

addFunction

addMacroInvocation

hasFunctions

getNames

hasNames

with

with

merge

toString

replaceElement

accept

children