AdditionalDocs (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.d2d2.rt.AdditionalDocs

All Implemented Interfaces:

Formattable, Cloneable
```
public class AdditionalDocs
extends Object
implements Cloneable, Formattable
```
Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "Rt.umod":83.3-86.12, cf. this pretty print.)

Field Summary

Fields
Modifier and Type	Field and Description
`static Function<AdditionalDocs,CheckedMap_RD<String,CheckedMap_RD<String,CheckedMap_RD<String,CheckedList<LocString>>>>>`	`get_text` Deprecated. Use new '::' method reference instead.
`protected CheckedMap_RD<String,CheckedMap_RD<String,CheckedMap_RD<String,CheckedList<LocString>>>>`	`text` Generated by umod; model author's documentation MISSING.

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

Constructor Summary

Constructors
Constructor and Description

AdditionalDocs()
Synthetic minimal constructor provided by the umod compiler.

Constructors
Constructor and Description
`AdditionalDocs()` Synthetic minimal constructor provided by the umod compiler.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add_text(String key0, String key1, String key2, LocString value)` Convenience un-Currying method.
`boolean`	`containsKey_text(String key0)` Convenience un-Currying method.
`boolean`	`containsKey_text(String key0, String key1)` Convenience un-Currying method.
`boolean`	`containsKey_text(String key0, String key1, String key2)` Convenience un-Currying method.
`void`	`descend_text(MATCH_ONLY_00 visitor)`
`AdditionalDocs`	`doclone()` Clones this object.
`Format`	`format()` Delivers a format object for pretty-printing, as specified in the umod source.
`CheckedMap_RD<String,CheckedMap_RD<String,CheckedMap_RD<String,CheckedList<LocString>>>>`	`get_text()` Generated by umod; model author's documentation MISSING.
`static String`	`getFormatHint()` Delivers the format specification from the umod source.
`AdditionalDocs`	`initFrom(Object o0)` Copies values of all common fields from the argument.
`void`	`put_text(String key0, CheckedMap_RD<String,CheckedMap_RD<String,CheckedList<LocString>>> value)` Convenience un-Currying method.
`void`	`put_text(String key0, String key1, CheckedMap_RD<String,CheckedList<LocString>> value)` Convenience un-Currying method.
`void`	`put_text(String key0, String key1, String key2, CheckedList<LocString> value)` Convenience un-Currying method.
`boolean`	`set_text(CheckedMap_RD<String,CheckedMap_RD<String,CheckedMap_RD<String,CheckedList<LocString>>>> 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
  - text
```
protected CheckedMap_RD<String,CheckedMap_RD<String,CheckedMap_RD<String,CheckedList<LocString>>>> text
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "Rt.umod":84.5-52, cf. this pretty print.)
    The type of this field is CheckedMap_RD<java.lang.String(never null),CheckedMap_RD<java.lang.String(never null),CheckedMap_RD<java.lang.String(never null),CheckedList<LocString(never null)>(never null)>(never null)>(never null)>(never null)
    Its value defaults to an empty collection.
    
    See Also:
    
    get_text(), set_text(eu.bandm.tools.umod.runtime.CheckedMap_RD<java.lang.String, eu.bandm.tools.umod.runtime.CheckedMap_RD<java.lang.String, eu.bandm.tools.umod.runtime.CheckedMap_RD<java.lang.String, eu.bandm.tools.umod.runtime.CheckedList<eu.bandm.tools.d2d2.model.LocString>>>>)
  - get_text
```
@Deprecated
public static final Function<AdditionalDocs,CheckedMap_RD<String,CheckedMap_RD<String,CheckedMap_RD<String,CheckedList<LocString>>>>> get_text
```
    Deprecated. Use new '::' method reference instead.
- Constructor Detail
  - AdditionalDocs
```
public AdditionalDocs()
```
    Synthetic minimal constructor provided by the umod compiler.
    Constructor with minimal set of arguments, supplied automatically by the umod compiler, not explicitly by user.
    (All object fields are set to their default values.)
- Method Detail
  - doclone
```
public AdditionalDocs doclone()
```
    Clones this object. Method never fails, since Cloneable is known to be implemented.
    
    Returns:
    
    a fresh copy.
  - getFormatHint
```
public static String getFormatHint()
```
    Delivers the format specification from the umod source.
    The constant return value is ..
    text{$from' --- '$to{$from '---' $to{$from '---' $to[/]}[/]}[/]}[/]
    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
  - initFrom
```
public AdditionalDocs 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_text
```
public CheckedMap_RD<String,CheckedMap_RD<String,CheckedMap_RD<String,CheckedList<LocString>>>> get_text()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "Rt.umod":84.5-52, cf. this pretty print.)
    Generated getter method. @see #text
    
    Returns:
    
    The current field value of type CheckedMap_RD<java.lang.String(never null),CheckedMap_RD<java.lang.String(never null),CheckedMap_RD<java.lang.String(never null),CheckedList<LocString(never null)>(never null)>(never null)>(never null)>(never null)
  - set_text
```
public boolean set_text(CheckedMap_RD<String,CheckedMap_RD<String,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 "Rt.umod":84.5-52, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type CheckedMap_RD<java.lang.String(never null),CheckedMap_RD<java.lang.String(never null),CheckedMap_RD<java.lang.String(never null),CheckedList<LocString(never null)>(never null)>(never null)>(never null)>(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    text
  - put_text
```
public void put_text(String key0,
                     CheckedMap_RD<String,CheckedMap_RD<String,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 CheckedMap_RD<java.lang.String(never null),CheckedMap_RD<java.lang.String(never null),CheckedList<LocString(never null)>(never null)>(never null)>(never null)
    
    See Also:
    
    text
  - put_text
```
public void put_text(String key0,
                     String key1,
                     CheckedMap_RD<String,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 CheckedMap_RD<java.lang.String(never null),CheckedList<LocString(never null)>(never null)>(never null)
    
    See Also:
    
    text
  - put_text
```
public void put_text(String key0,
                     String key1,
                     String key2,
                     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:
    
    text
  - add_text
```
public void add_text(String key0,
                     String key1,
                     String key2,
                     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:
    
    text
  - containsKey_text
```
public boolean containsKey_text(String key0)
```
    Convenience un-Currying method.
    
    Returns:
    
    whether there exists a chain of collection objects to the given co-ordinate.
    
    See Also:
    
    text
  - containsKey_text
```
public boolean containsKey_text(String key0,
                                String key1)
```
    Convenience un-Currying method.
    
    Returns:
    
    whether there exists a chain of collection objects to the given co-ordinate.
    
    See Also:
    
    text
  - containsKey_text
```
public boolean containsKey_text(String key0,
                                String key1,
                                String key2)
```
    Convenience un-Currying method.
    
    Returns:
    
    whether there exists a chain of collection objects to the given co-ordinate.
    
    See Also:
    
    text
  - descend_text
```
public void descend_text(MATCH_ONLY_00 visitor)
```

Class AdditionalDocs

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

text

get_text

Constructor Detail

AdditionalDocs

Method Detail

doclone

getFormatHint

format

initFrom

get_text

set_text

put_text

put_text

put_text

add_text

containsKey_text

containsKey_text

containsKey_text

descend_text