gololang.ir

Class GoloModule

java.lang.Object

gololang.ir.GoloElement<GoloModule>

gololang.ir.GoloModule

All Implemented Interfaces:

FunctionContainer, java.lang.Iterable<GoloFunction>

public final class GoloModule
extends GoloElement<GoloModule>
implements FunctionContainer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MODULE_INITIALIZER_FUNCTION
static java.lang.String	TYPE_SUBPACKAGE

Method Summary

Modifier and Type	Method and Description
void	accept(GoloIrVisitor visitor) Accept the visitor.
GoloModule	add(GoloElement<?> element)
void	addFunction(GoloFunction function) 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.
static GoloModule	create(PackageAndClass name, ReferenceTable references)
java.util.Optional<MacroInvocation>	decoratorMacro()
GoloModule	decoratorMacro(MacroInvocation macro)
GoloModule	enclosingModule() Returns the module containing this element.
java.util.Collection<Augmentation>	getAugmentations()
java.util.List<GoloFunction>	getFunctions()
java.util.Set<ModuleImport>	getImports() Returns the module imported by this module, including the implicit ones.
PackageAndClass	getPackageAndClass()
ReferenceTable	getReferenceTable()
GoloElement<?>	getSubtypeByName(java.lang.String name)
PackageAndClass	getTypesPackage()
java.util.Set<java.lang.String>	getUsedModules() Returns the names of the modules used by this module.
boolean	hasFunctions()
boolean	hasMacros()
boolean	hasMain()
boolean	isEmpty()
protected void	replaceElement(GoloElement<?> original, GoloElement<?> newElement) Replace a child.
protected GoloModule	self()
java.lang.String	sourceFile()
GoloModule	sourceFile(java.lang.String file)
java.lang.String	toString()

Methods inherited from class gololang.ir.GoloElement

ancestor, ancestor, ancestorOfType, cantConvert, cantReplace, cantReplace, children, children, descendants, descendants, descendants, documentation, documentation, doesNotContain, 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

Field Detail

MODULE_INITIALIZER_FUNCTION

public static final java.lang.String MODULE_INITIALIZER_FUNCTION

See Also:

Constant Field Values

TYPE_SUBPACKAGE

public static final java.lang.String TYPE_SUBPACKAGE

See Also:

Constant Field Values

Method Detail

create

public static GoloModule create(PackageAndClass name,
                                ReferenceTable references)

self

protected GoloModule self()

Specified by:

self in class GoloElement<GoloModule>

getPackageAndClass

public PackageAndClass getPackageAndClass()

Specified by:

getPackageAndClass in interface FunctionContainer

getTypesPackage

public PackageAndClass getTypesPackage()

sourceFile

public java.lang.String sourceFile()

sourceFile

public GoloModule sourceFile(java.lang.String file)

getReferenceTable

public ReferenceTable getReferenceTable()

enclosingModule

public GoloModule enclosingModule()

Returns the module containing this element.

Overrides:

enclosingModule in class GoloElement<GoloModule>

Returns:

the module itself.

getImports

public java.util.Set<ModuleImport> getImports()

Returns the module imported by this module, including the implicit ones.

getUsedModules

public java.util.Set<java.lang.String> getUsedModules()

Returns the names of the modules used by this module.

Since the use macro can inject other dependencies, this list can be not complete. The macro is not expanded.

getAugmentations

public java.util.Collection<Augmentation> getAugmentations()

decoratorMacro

public GoloModule decoratorMacro(MacroInvocation macro)

decoratorMacro

public java.util.Optional<MacroInvocation> decoratorMacro()

getFunctions

public java.util.List<GoloFunction> getFunctions()

Specified by:

getFunctions in interface FunctionContainer

hasFunctions

public boolean hasFunctions()

Specified by:

hasFunctions in interface FunctionContainer

hasMacros

public boolean hasMacros()

hasMain

public boolean hasMain()

addFunction

public void addFunction(GoloFunction function)

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

getSubtypeByName

public GoloElement<?> getSubtypeByName(java.lang.String name)

add

public GoloModule add(GoloElement<?> element)

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

children

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

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

Overrides:

children in class GoloElement<GoloModule>

isEmpty

public boolean isEmpty()

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

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)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object