Package eu.bandm.tools.d2d2.model

Class AdditionalDocs

java.lang.Object

eu.bandm.tools.d2d2.model.AdditionalDocs

All Implemented Interfaces:

Formattable, Cloneable

@Generated(generator="eu.bandm.tools.umod",
           version="",
           timestamp="2026-01-24_19h42m14")
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 "D2d.umod":291.3-295.12, see this pretty print.)

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<AdditionalDocs,NonNullMap<String,NonNullMap<String,NonNullMap<String,NonNullList<LocString>>>>>	get_text	Deprecated. Use new '::' method reference instead.
protected NonNullMap<String,NonNullMap<String,NonNullMap<String,NonNullList<LocString>>>>	text	realizes the mapping language(/target) -> modulename -> definition -> docText.

Constructor Summary

Constructors

Constructor	Description
AdditionalDocs()	Constructor with minimal set of arguments, is supplied automatically by the umod compiler, not explicitly by the user. (All object fields are set to their default values.)

Method Summary

Modifier and Type	Method	Description
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.
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)	Deprecated. Use visitor.follow_text(this) or visitor.followAll_text(this) instead.
AdditionalDocs	doclone()	Clones this object.
Format	format()	Delivers a format object for pretty-printing, as specified in the umod source.
NonNullMap<String,NonNullMap<String,NonNullMap<String,NonNullList<LocString>>>>	get_text()	realizes the mapping language(/target) -> modulename -> definition -> docText.
static Pattern<AdditionalDocs>	get_text(Pattern<? super NonNullMap<String,NonNullMap<String,NonNullMap<String,NonNullList<LocString>>>>> p)	Lifts a pattern which matches the field value to one which matches this whole object.
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, NonNullMap<String,NonNullMap<String,NonNullList<LocString>>> value)	Convenience un-Currying method. Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
void	put_text(String key0, String key1, NonNullMap<String,NonNullList<LocString>> value)	Convenience un-Currying method. Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
void	put_text(String key0, String key1, String key2, NonNullList<LocString> value)	Convenience un-Currying method. Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
boolean	set_text(NonNullMap<String,NonNullMap<String,NonNullMap<String,NonNullList<LocString>>>> val)	realizes the mapping language(/target) -> modulename -> definition -> docText.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

text

protected NonNullMap<String,NonNullMap<String,NonNullMap<String,NonNullList<LocString>>>> text

realizes the mapping language(/target) -> modulename -> definition -> docText.

(This definition has been created by UMod from the source at SYSTEM "D2d.umod":292.5-293.5, see this pretty print.)
The type of this field is NonNullMap<java.lang.String(never null),NonNullMap<java.lang.String(never null),NonNullMap<java.lang.String(never null),NonNullList<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.util.nonnull.NonNullMap<java.lang.String, eu.bandm.tools.util.nonnull.NonNullMap<java.lang.String, eu.bandm.tools.util.nonnull.NonNullMap<java.lang.String, eu.bandm.tools.util.nonnull.NonNullList<eu.bandm.tools.d2d2.model.LocString>>>>)

get_text

@Deprecated
public static final Function<AdditionalDocs,NonNullMap<String,NonNullMap<String,NonNullMap<String,NonNullList<LocString>>>>> get_text

Deprecated.

Use new '::' method reference instead.

Constructor Details

AdditionalDocs

public AdditionalDocs()

Constructor with minimal set of arguments, is supplied automatically by the umod compiler, not explicitly by the user.
(All object fields are set to their default values.)

Method Details

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

Returns:

a format that represents this object in a pretty-printable way

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 NonNullMap<String,NonNullMap<String,NonNullMap<String,NonNullList<LocString>>>> get_text()

realizes the mapping language(/target) -> modulename -> definition -> docText.

(This definition has been created by UMod from the source at SYSTEM "D2d.umod":292.5-293.5, see this pretty print.)
Generated getter method.

Returns:

The current field value of type NonNullMap<java.lang.String(never null),NonNullMap<java.lang.String(never null),NonNullMap<java.lang.String(never null),NonNullList<LocString(never null)>(never null)>(never null)>(never null)>(never null)

See Also:

• text

set_text

public boolean set_text(NonNullMap<String,NonNullMap<String,NonNullMap<String,NonNullList<LocString>>>> val)

realizes the mapping language(/target) -> modulename -> definition -> docText.

(This definition has been created by UMod from the source at SYSTEM "D2d.umod":292.5-293.5, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type NonNullMap<java.lang.String(never null),NonNullMap<java.lang.String(never null),NonNullMap<java.lang.String(never null),NonNullList<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,
 NonNullMap<String,NonNullMap<String,NonNullList<LocString>>> value)

Convenience un-Currying method.
Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.

Parameters:

value - the new value of type NonNullMap<java.lang.String(never null),NonNullMap<java.lang.String(never null),NonNullList<LocString(never null)>(never null)>(never null)>(never null)

See Also:

• text

put_text

public void put_text(String key0,
 String key1,
 NonNullMap<String,NonNullList<LocString>> value)

Convenience un-Currying method.
Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.

Parameters:

value - the new value of type NonNullMap<java.lang.String(never null),NonNullList<LocString(never null)>(never null)>(never null)

See Also:

• text

put_text

public void put_text(String key0,
 String key1,
 String key2,
 NonNullList<LocString> value)

Convenience un-Currying method.
Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.

Parameters:

value - the new value of type NonNullList<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:

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

@Deprecated
public void descend_text(MATCH_ONLY_00 visitor)

Deprecated.

Use visitor.follow_text(this) or visitor.followAll_text(this) instead.

get_text

public static Pattern<AdditionalDocs> get_text(Pattern<? super NonNullMap<String,NonNullMap<String,NonNullMap<String,NonNullList<LocString>>>>> p)

Lifts a pattern which matches the field value to one which matches this whole object.
More complex pattern methods are generated in the one ancillary class __Patterns.