SourceItem (BandM metatools API doc)

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

All Implemented Interfaces:

Formattable, Serializable, Cloneable

Direct Known Subclasses:

Definition, ImportItem, Module
```
public class SourceItem
extends Object
implements Cloneable, Formattable, Serializable
```
Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "D2d.umod":169.3-174.9, cf. this pretty print.)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected SourceItem`	`context` Generated by umod; model author's documentation MISSING.
`protected CheckedMap_RD<String,CheckedList<LocString>>`	`docu` Generated by umod; model author's documentation MISSING.
`static Function<SourceItem,SourceItem>`	`get_context` Deprecated. Use new '::' method reference instead.
`static Function<SourceItem,CheckedMap_RD<String,CheckedList<LocString>>>`	`get_docu` Deprecated. Use new '::' method reference instead.
`static Function<SourceItem,Location<XMLDocumentIdentifier>>`	`get_location` Deprecated. Use new '::' method reference instead.
`static Function<SourceItem,String>`	`get_name` Deprecated. Use new '::' method reference instead.
`protected Location<XMLDocumentIdentifier>`	`location` Generated by umod; model author's documentation MISSING.
`protected String`	`name` Generated by umod; model author's documentation MISSING.

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add_docu(String key0, LocString value)` Convenience un-Currying method.
`boolean`	`containsKey_docu(String key0)` Convenience un-Currying method.
`void`	`descend_docu(MATCH_ONLY_00 visitor)`
`SourceItem`	`doclone()` Clones this object.
`Format`	`format()` Delivers a format object for pretty-printing by inheritance from some ancestor class.
`String`	`fullPath()`
`SourceItem`	`get_context()` Generated by umod; model author's documentation MISSING.
`CheckedMap_RD<String,CheckedList<LocString>>`	`get_docu()` Generated by umod; model author's documentation MISSING.
`Location<XMLDocumentIdentifier>`	`get_location()` Generated by umod; model author's documentation MISSING.
`String`	`get_name()` Generated by umod; model author's documentation MISSING.
`SourceItem`	`initFrom(Object o0)` Copies values of all common fields from the argument.
`void`	`put_docu(String key0, CheckedList<LocString> value)` Convenience un-Currying method.
`boolean`	`set_context(SourceItem val)` Generated by umod; model author's documentation MISSING.
`boolean`	`set_docu(CheckedMap_RD<String,CheckedList<LocString>> val)` Generated by umod; model author's documentation MISSING.
`boolean`	`set_location(Location<XMLDocumentIdentifier> val)` Generated by umod; model author's documentation MISSING.
`boolean`	`set_name(String val)` Generated by umod; model author's documentation MISSING.

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

- Field Detail
  - context
```
protected SourceItem context
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":170.9-58, cf. this pretty print.)
    The type of this field is SourceItem(maybe null)
    Its value defaults to null.
    
    See Also:
    
    get_context(), set_context(eu.bandm.tools.d2d2.model.SourceItem)
  - get_context
```
@Deprecated
public static final Function<SourceItem,SourceItem> get_context
```
    Deprecated. Use new '::' method reference instead.
  - name
```
protected String name
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":171.9-57, cf. this pretty print.)
    The type of this field is java.lang.String(never null)
    It is set by every possible constructor.
    
    See Also:
    
    get_name(), set_name(java.lang.String)
  - get_name
```
@Deprecated
public static final Function<SourceItem,String> get_name
```
    Deprecated. Use new '::' method reference instead.
  - location
```
protected Location<XMLDocumentIdentifier> location
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":172.9-57, cf. this pretty print.)
    The type of this field is Location(never null)
    It is set by every possible constructor.
    
    See Also:
    
    get_location(), set_location(eu.bandm.tools.message.Location<eu.bandm.tools.message.XMLDocumentIdentifier>)
  - get_location
```
@Deprecated
public static final Function<SourceItem,Location<XMLDocumentIdentifier>> get_location
```
    Deprecated. Use new '::' method reference instead.
  - docu
```
protected CheckedMap_RD<String,CheckedList<LocString>> docu
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":173.9-39, cf. this pretty print.)
    The type of this field is CheckedMap_RD<java.lang.String(never null),CheckedList<LocString(never null)>(never null)>(never null)
    Its value defaults to an empty collection.
    
    See Also:
    
    get_docu(), set_docu(eu.bandm.tools.umod.runtime.CheckedMap_RD<java.lang.String, eu.bandm.tools.umod.runtime.CheckedList<eu.bandm.tools.d2d2.model.LocString>>)
  - get_docu
```
@Deprecated
public static final Function<SourceItem,CheckedMap_RD<String,CheckedList<LocString>>> get_docu
```
    Deprecated. Use new '::' method reference instead.
- Constructor Detail
  - SourceItem
```
public SourceItem(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 context
    
    name - is copied to field name
    
    location - is copied to field location
  - SourceItem
```
public SourceItem(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 name
    
    location - is copied to field location
- Method Detail
  - doclone
```
public SourceItem doclone()
```
    Clones this object. Method never fails, since Cloneable is known to be implemented.
    
    Returns:
    
    a fresh copy.
  - format
```
public Format format()
```
    Delivers a format object for pretty-printing by inheritance from some ancestor class.
    
    Specified by:
    
    format in interface Formattable
  - fullPath
```
public String fullPath()
```
  - initFrom
```
public SourceItem 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.
  - get_context
```
public SourceItem get_context()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":170.9-58, cf. this pretty print.)
    Generated getter method. @see #context
    
    Returns:
    
    The current field value of type SourceItem(maybe null)
  - set_context
```
public boolean set_context(SourceItem val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":170.9-58, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type SourceItem(maybe null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    context
  - get_name
```
public String get_name()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":171.9-57, cf. this pretty print.)
    Generated getter method. @see #name
    
    Returns:
    
    The current field value of type java.lang.String(never null)
  - set_name
```
public boolean set_name(String val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":171.9-57, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type java.lang.String(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    name
  - get_location
```
public Location<XMLDocumentIdentifier> get_location()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":172.9-57, cf. this pretty print.)
    Generated getter method. @see #location
    
    Returns:
    
    The current field value of type Location(never null)
  - set_location
```
public boolean set_location(Location<XMLDocumentIdentifier> val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":172.9-57, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type Location(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    location
  - get_docu
```
public CheckedMap_RD<String,CheckedList<LocString>> get_docu()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":173.9-39, cf. this pretty print.)
    Generated getter method. @see #docu
    
    Returns:
    
    The current field value of type CheckedMap_RD<java.lang.String(never null),CheckedList<LocString(never null)>(never null)>(never null)
  - set_docu
```
public boolean set_docu(CheckedMap_RD<String,CheckedList<LocString>> val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "D2d.umod":173.9-39, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type CheckedMap_RD<java.lang.String(never null),CheckedList<LocString(never null)>(never null)>(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    docu
  - put_docu
```
public void put_docu(String key0,
                     CheckedList<LocString> 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 CheckedList<LocString(never null)>(never null)
    
    See Also:
    
    docu
  - add_docu
```
public void add_docu(String key0,
                     LocString 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 LocString(never null)
    
    See Also:
    
    docu
  - containsKey_docu
```
public boolean containsKey_docu(String key0)
```
    Convenience un-Currying method.
    
    Returns:
    
    whether there exists a chain of collection objects to the given co-ordinate.
    
    See Also:
    
    docu
  - descend_docu
```
public void descend_docu(MATCH_ONLY_00 visitor)
```

Class SourceItem

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

context

get_context

name

get_name

location

get_location

docu

get_docu

Constructor Detail

SourceItem

SourceItem

Method Detail

doclone

format

fullPath

initFrom

get_context

set_context

get_name

set_name

get_location

set_location

get_docu

set_docu

put_docu

add_docu

containsKey_docu

descend_docu