Module (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.d2d2.model.SourceItem
- - eu.bandm.tools.d2d2.model.Module

All Implemented Interfaces:

Formattable, Serializable, Cloneable

Direct Known Subclasses:

ResolvedModule
```
public class Module
extends SourceItem
```
Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "D2d.umod":183.3-198.9, cf. this pretty print.)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected NamespaceName`	`defaultElNs` Generated by umod; model author's documentation MISSING.
`protected CheckedMap_RD<String,Definition>`	`definitions` Generated by umod; model author's documentation MISSING.
`static Function<Module,NamespaceName>`	`get_defaultElNs` Deprecated. Use new '::' method reference instead.
`static Function<Module,CheckedMap_RD<String,Definition>>`	`get_definitions` Deprecated. Use new '::' method reference instead.
`static Function<Module,CheckedMap_RD<String,ImportItem>>`	`get_imports` Deprecated. Use new '::' method reference instead.
`static Function<Module,Boolean>`	`get_isLocal` Deprecated. Use new '::' method reference instead.
`static Function<Module,CheckedMap_RD<String,Module>>`	`get_modules` Deprecated. Use new '::' method reference instead.
`static Function<Module,CheckedList<NamespaceDecl>>`	`get_namespaces` Deprecated. Use new '::' method reference instead.
`protected CheckedMap_RD<String,ImportItem>`	`imports` Generated by umod; model author's documentation MISSING.
`protected boolean`	`isLocal` Generated by umod; model author's documentation MISSING.
`protected CheckedMap_RD<String,Module>`	`modules` Generated by umod; model author's documentation MISSING.
`protected CheckedList<NamespaceDecl>`	`namespaces` Generated by umod; model author's documentation MISSING.

Fields inherited from class eu.bandm.tools.d2d2.model.SourceItem
context, docu, get_context, get_docu, get_location, get_name, location, name

Fields inherited from interface eu.bandm.tools.format.Formattable
format

Constructor Summary

Constructors
Constructor and Description
`Module(SourceItem context, String name, Location<XMLDocumentIdentifier> location)` Constructor generated according to specification #0 Constructor defined according to directive "`C 0/.."`.
`Module(String name, Location<XMLDocumentIdentifier> location)` Synthetic minimal constructor provided by the umod compiler.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsKey_definitions(String key0)` Convenience un-Currying method.
`boolean`	`containsKey_imports(String key0)` Convenience un-Currying method.
`boolean`	`containsKey_modules(String key0)` Convenience un-Currying method.
`void`	`descend_0_definitions(MATCH_ONLY_00 visitor)`
`void`	`descend_0_imports(MATCH_ONLY_00 visitor)`
`void`	`descend_0_modules(MATCH_ONLY_00 visitor)`
`void`	`descend_2_definitions(MATCH_ONLY_00 visitor)`
`void`	`descend_2_imports(MATCH_ONLY_00 visitor)`
`void`	`descend_definitions(MATCH_ONLY_00 visitor)`
`void`	`descend_imports(MATCH_ONLY_00 visitor)`
`void`	`descend_modules(MATCH_ONLY_00 visitor)`
`void`	`descend_namespaces(MATCH_ONLY_00 visitor)`
`Module`	`doclone()` Clones this object.
`SourceItem`	`find(String s)`
`Format`	`format()` Delivers a format object for pretty-printing, as specified in the umod source.
`NamespaceName`	`get_defaultElNs()` Generated by umod; model author's documentation MISSING.
`CheckedMap_RD<String,Definition>`	`get_definitions()` Generated by umod; model author's documentation MISSING.
`CheckedMap_RD<String,ImportItem>`	`get_imports()` Generated by umod; model author's documentation MISSING.
`boolean`	`get_isLocal()` Generated by umod; model author's documentation MISSING.
`CheckedMap_RD<String,Module>`	`get_modules()` Generated by umod; model author's documentation MISSING.
`CheckedList<NamespaceDecl>`	`get_namespaces()` Generated by umod; model author's documentation MISSING.
`static String`	`getFormatHint()` Delivers the format specification from the umod source.
`Module`	`initFrom(Object o0)` Copies values of all common fields from the argument.
`void`	`put_definitions(String key0, Definition value)` Convenience un-Currying method.
`void`	`put_imports(String key0, ImportItem value)` Convenience un-Currying method.
`void`	`put_modules(String key0, Module value)` Convenience un-Currying method.
`boolean`	`set_defaultElNs(NamespaceName val)` Generated by umod; model author's documentation MISSING.
`boolean`	`set_definitions(CheckedMap_RD<String,Definition> val)` Generated by umod; model author's documentation MISSING.
`boolean`	`set_imports(CheckedMap_RD<String,ImportItem> val)` Generated by umod; model author's documentation MISSING.
`boolean`	`set_isLocal(boolean val)` Generated by umod; model author's documentation MISSING.
`boolean`	`set_modules(CheckedMap_RD<String,Module> val)` Generated by umod; model author's documentation MISSING.
`boolean`	`set_namespaces(CheckedList<NamespaceDecl> val)` Generated by umod; model author's documentation MISSING.

Methods inherited from class eu.bandm.tools.d2d2.model.SourceItem
add_docu, containsKey_docu, descend_docu, fullPath, get_context, get_docu, get_location, get_name, put_docu, set_context, set_docu, set_location, set_name

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

- Field Detail
  - modules
```
protected CheckedMap_RD<String,Module> modules
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":184.9-73, cf. this pretty print.)
    The type of this field is CheckedMap_RD<java.lang.String(never null),Module(never null)>(never null)
    Its value defaults to an empty collection.
    
    See Also:
    
    get_modules(), set_modules(eu.bandm.tools.umod.runtime.CheckedMap_RD<java.lang.String, eu.bandm.tools.d2d2.model.Module>)
  - get_modules
```
@Deprecated
public static final Function<Module,CheckedMap_RD<String,Module>> get_modules
```
    Deprecated. Use new '::' method reference instead.
  - imports
```
protected CheckedMap_RD<String,ImportItem> imports
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":185.9-79, cf. this pretty print.)
    The type of this field is CheckedMap_RD<java.lang.String(never null),ImportItem(never null)>(never null)
    Its value defaults to an empty collection.
    
    See Also:
    
    get_imports(), set_imports(eu.bandm.tools.umod.runtime.CheckedMap_RD<java.lang.String, eu.bandm.tools.d2d2.model.ImportItem>)
  - get_imports
```
@Deprecated
public static final Function<Module,CheckedMap_RD<String,ImportItem>> get_imports
```
    Deprecated. Use new '::' method reference instead.
  - definitions
```
protected CheckedMap_RD<String,Definition> definitions
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":186.9-79, cf. this pretty print.)
    The type of this field is CheckedMap_RD<java.lang.String(never null),Definition(never null)>(never null)
    Its value defaults to an empty collection.
    
    See Also:
    
    get_definitions(), set_definitions(eu.bandm.tools.umod.runtime.CheckedMap_RD<java.lang.String, eu.bandm.tools.d2d2.model.Definition>)
  - get_definitions
```
@Deprecated
public static final Function<Module,CheckedMap_RD<String,Definition>> get_definitions
```
    Deprecated. Use new '::' method reference instead.
  - defaultElNs
```
protected NamespaceName defaultElNs
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":189.9-29, cf. this pretty print.)
    The type of this field is NamespaceName(maybe null)
    Its value defaults to null.
    
    See Also:
    
    get_defaultElNs(), set_defaultElNs(eu.bandm.tools.util.NamespaceName)
  - get_defaultElNs
```
@Deprecated
public static final Function<Module,NamespaceName> get_defaultElNs
```
    Deprecated. Use new '::' method reference instead.
  - namespaces
```
protected CheckedList<NamespaceDecl> namespaces
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":192.9-29, cf. this pretty print.)
    The type of this field is CheckedList<NamespaceDecl(never null)>(never null)
    Its value defaults to an empty collection.
    
    See Also:
    
    get_namespaces(), set_namespaces(eu.bandm.tools.umod.runtime.CheckedList<eu.bandm.tools.d2d2.model.NamespaceDecl>)
  - get_namespaces
```
@Deprecated
public static final Function<Module,CheckedList<NamespaceDecl>> get_namespaces
```
    Deprecated. Use new '::' method reference instead.
  - isLocal
```
protected boolean isLocal
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":194.9-32, cf. this pretty print.)
    The type of this field is boolean(never null)
    Its value defaults to false.
    
    See Also:
    
    get_isLocal(), set_isLocal(boolean)
  - get_isLocal
```
@Deprecated
public static final Function<Module,Boolean> get_isLocal
```
    Deprecated. Use new '::' method reference instead.
- Constructor Detail
  - Module
```
public Module(SourceItem context,
              String name,
              Location<XMLDocumentIdentifier> location)
```
    Constructor generated according to specification #0
    Constructor defined according to directive "C 0/..".
    
    Parameters:
    
    context - is copied to field SourceItem.context
    
    name - is copied to field SourceItem.name
    
    location - is copied to field SourceItem.location
  - Module
```
public Module(String name,
              Location<XMLDocumentIdentifier> location)
```
    Synthetic minimal constructor provided by the umod compiler.
    Constructor with minimal set of arguments, supplied automatically by the umod compiler, not explicitly by user.
    
    Parameters:
    
    name - is copied to field SourceItem.name
    
    location - is copied to field SourceItem.location
- Method Detail
  - doclone
```
public Module doclone()
```
    Clones this object. Method never fails, since Cloneable is known to be implemented.
    
    Overrides:
    
    doclone in class SourceItem
    
    Returns:
    
    a fresh copy.
  - getFormatHint
```
public static String getFormatHint()
```
    Delivers the format specification from the umod source.
    The constant return value is ..
    (($is ResolvedModule $this)'resolved' ?)'module 'name/ /4>namespaces[/]/ /4>(modules{$to}[/])/ / /imports{$to}[/]/ /definitions{$to}[/(' '/' ')/]/ /'end module //'name/ /
    This can be used e.g. by format code interpreters which process objects of different origin.
  - format
```
public Format format()
```
    Delivers a format object for pretty-printing, as specified in the umod source.
    
    Specified by:
    
    format in interface Formattable
    
    Overrides:
    
    format in class SourceItem
  - find
```
public SourceItem find(String s)
```
  - initFrom
```
public Module initFrom(Object o0)
```
    Copies values of all common fields from the argument. All fields of this class definition are copied, iff the argument is of this class. Then the superclass method is invoked with the same argument.
    
    Overrides:
    
    initFrom in class SourceItem
  - get_modules
```
public CheckedMap_RD<String,Module> get_modules()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":184.9-73, cf. this pretty print.)
    Generated getter method. @see #modules
    
    Returns:
    
    The current field value of type CheckedMap_RD<java.lang.String(never null),Module(never null)>(never null)
  - set_modules
```
public boolean set_modules(CheckedMap_RD<String,Module> val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":184.9-73, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type CheckedMap_RD<java.lang.String(never null),Module(never null)>(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    modules
  - put_modules
```
public void put_modules(String key0,
                        Module value)
```
    Convenience un-Currying method.
    Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
    
    Parameters:
    
    val - the new value of type Module(never null)
    
    See Also:
    
    modules
  - containsKey_modules
```
public boolean containsKey_modules(String key0)
```
    Convenience un-Currying method.
    
    Returns:
    
    whether there exists a chain of collection objects to the given co-ordinate.
    
    See Also:
    
    modules
  - descend_modules
```
public void descend_modules(MATCH_ONLY_00 visitor)
```
  - descend_0_modules
```
public void descend_0_modules(MATCH_ONLY_00 visitor)
```
  - get_imports
```
public CheckedMap_RD<String,ImportItem> get_imports()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":185.9-79, cf. this pretty print.)
    Generated getter method. @see #imports
    
    Returns:
    
    The current field value of type CheckedMap_RD<java.lang.String(never null),ImportItem(never null)>(never null)
  - set_imports
```
public boolean set_imports(CheckedMap_RD<String,ImportItem> val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":185.9-79, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type CheckedMap_RD<java.lang.String(never null),ImportItem(never null)>(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    imports
  - put_imports
```
public void put_imports(String key0,
                        ImportItem value)
```
    Convenience un-Currying method.
    Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
    
    Parameters:
    
    val - the new value of type ImportItem(never null)
    
    See Also:
    
    imports
  - containsKey_imports
```
public boolean containsKey_imports(String key0)
```
    Convenience un-Currying method.
    
    Returns:
    
    whether there exists a chain of collection objects to the given co-ordinate.
    
    See Also:
    
    imports
  - descend_imports
```
public void descend_imports(MATCH_ONLY_00 visitor)
```
  - descend_0_imports
```
public void descend_0_imports(MATCH_ONLY_00 visitor)
```
  - descend_2_imports
```
public void descend_2_imports(MATCH_ONLY_00 visitor)
```
  - get_definitions
```
public CheckedMap_RD<String,Definition> get_definitions()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":186.9-79, cf. this pretty print.)
    Generated getter method. @see #definitions
    
    Returns:
    
    The current field value of type CheckedMap_RD<java.lang.String(never null),Definition(never null)>(never null)
  - set_definitions
```
public boolean set_definitions(CheckedMap_RD<String,Definition> val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":186.9-79, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type CheckedMap_RD<java.lang.String(never null),Definition(never null)>(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    definitions
  - put_definitions
```
public void put_definitions(String key0,
                            Definition value)
```
    Convenience un-Currying method.
    Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
    
    Parameters:
    
    val - the new value of type Definition(never null)
    
    See Also:
    
    definitions
  - containsKey_definitions
```
public boolean containsKey_definitions(String key0)
```
    Convenience un-Currying method.
    
    Returns:
    
    whether there exists a chain of collection objects to the given co-ordinate.
    
    See Also:
    
    definitions
  - descend_definitions
```
public void descend_definitions(MATCH_ONLY_00 visitor)
```
  - descend_0_definitions
```
public void descend_0_definitions(MATCH_ONLY_00 visitor)
```
  - descend_2_definitions
```
public void descend_2_definitions(MATCH_ONLY_00 visitor)
```
  - get_defaultElNs
```
public NamespaceName get_defaultElNs()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":189.9-29, cf. this pretty print.)
    Generated getter method. @see #defaultElNs
    
    Returns:
    
    The current field value of type NamespaceName(maybe null)
  - set_defaultElNs
```
public boolean set_defaultElNs(NamespaceName val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":189.9-29, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type NamespaceName(maybe null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    defaultElNs
  - get_namespaces
```
public CheckedList<NamespaceDecl> get_namespaces()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":192.9-29, cf. this pretty print.)
    Generated getter method. @see #namespaces
    
    Returns:
    
    The current field value of type CheckedList<NamespaceDecl(never null)>(never null)
  - set_namespaces
```
public boolean set_namespaces(CheckedList<NamespaceDecl> val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":192.9-29, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type CheckedList<NamespaceDecl(never null)>(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    namespaces
  - descend_namespaces
```
public void descend_namespaces(MATCH_ONLY_00 visitor)
```
  - get_isLocal
```
public boolean get_isLocal()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":194.9-32, cf. this pretty print.)
    Generated getter method. @see #isLocal
    
    Returns:
    
    The current field value of type boolean(never null)
  - set_isLocal
```
public boolean set_isLocal(boolean val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":194.9-32, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type boolean(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    isLocal

Class Module

Field Summary

Fields inherited from class eu.bandm.tools.d2d2.model.SourceItem

Fields inherited from interface eu.bandm.tools.format.Formattable

Constructor Summary

Method Summary

Methods inherited from class eu.bandm.tools.d2d2.model.SourceItem

Methods inherited from class java.lang.Object

Field Detail

modules

get_modules

imports

get_imports

definitions

get_definitions

defaultElNs

get_defaultElNs

namespaces

get_namespaces

isLocal

get_isLocal

Constructor Detail

Module

Module

Method Detail

doclone

getFormatHint

format

find

initFrom

get_modules

set_modules

put_modules

containsKey_modules

descend_modules

descend_0_modules

get_imports

set_imports

put_imports

containsKey_imports

descend_imports

descend_0_imports

descend_2_imports

get_definitions

set_definitions

put_definitions

containsKey_definitions

descend_definitions

descend_0_definitions

descend_2_definitions

get_defaultElNs

set_defaultElNs

get_namespaces

set_namespaces

descend_namespaces

get_isLocal

set_isLocal