DTD.Dtd (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.dtd.DTD.Dtd

All Implemented Interfaces:

Formattable, Cloneable

Enclosing class:

DTD
```
public static class DTD.Dtd
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 "DTD.umod":21.1-32.3, cf. this pretty print.)

Field Summary

Fields
Modifier and Type	Field and Description
`protected XMLDocumentIdentifier`	`documentId` Generated by umod; model author's documentation MISSING.
`protected CheckedMultimap_RD<String,String>`	`entityUsage` Generated by umod; model author's documentation MISSING.
`protected List<Location<XMLDocumentIdentifier>>`	`locations` Generated by umod; model author's documentation MISSING.
`protected CheckedList<DTD.MarkupDecl>`	`markup` Generated by umod; model author's documentation MISSING.
`protected DTD.TextDecl`	`textDecl` Generated by umod; model author's documentation MISSING.

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

Constructor Summary

Constructors
Constructor and Description
`Dtd()` Synthetic minimal constructor provided by the umod compiler.
`Dtd(XMLDocumentIdentifier documentId)` Constructor generated according to specification #1 Constructor defined according to directive "`C 1/.."`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`descend_locations(DTD.MATCH_ONLY_00 visitor)`
`void`	`descend_markup(DTD.MATCH_ONLY_00 visitor)`
`DTD.Dtd`	`doclone()` Clones this object.
`Format`	`format()` Delivers a format object for pretty-printing, as specified in the umod source.
`XMLDocumentIdentifier`	`get_documentId()` Generated by umod; model author's documentation MISSING.
`static Pattern<DTD.Dtd>`	`get_documentId(Pattern<? super XMLDocumentIdentifier> p)` Lifts a pattern which matches the field value to one which matches this whole object.
`CheckedMultimap_RD<String,String>`	`get_entityUsage()` Generated by umod; model author's documentation MISSING.
`static Pattern<DTD.Dtd>`	`get_entityUsage(Pattern<? super CheckedMultimap_RD<String,String>> p)` Lifts a pattern which matches the field value to one which matches this whole object.
`List<Location<XMLDocumentIdentifier>>`	`get_locations()` Generated by umod; model author's documentation MISSING.
`static Pattern<DTD.Dtd>`	`get_locations(Pattern<? super List<Location<XMLDocumentIdentifier>>> p)` Lifts a pattern which matches the field value to one which matches this whole object.
`CheckedList<DTD.MarkupDecl>`	`get_markup()` Generated by umod; model author's documentation MISSING.
`static Pattern<DTD.Dtd>`	`get_markup(Pattern<? super CheckedList<DTD.MarkupDecl>> p)` Lifts a pattern which matches the field value to one which matches this whole object.
`DTD.TextDecl`	`get_textDecl()` Generated by umod; model author's documentation MISSING.
`static Pattern<DTD.Dtd>`	`get_textDecl(Pattern<? super DTD.TextDecl> 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.
`DTD.Dtd`	`initFrom(Object o0)` Copies values of all common fields from the argument.
`boolean`	`set_documentId(XMLDocumentIdentifier val)` Generated by umod; model author's documentation MISSING.
`boolean`	`set_entityUsage(CheckedMultimap_RD<String,String> val)` Generated by umod; model author's documentation MISSING.
`boolean`	`set_locations(List<Location<XMLDocumentIdentifier>> val)` Generated by umod; model author's documentation MISSING.
`boolean`	`set_markup(CheckedList<DTD.MarkupDecl> val)` Generated by umod; model author's documentation MISSING.
`boolean`	`set_textDecl(DTD.TextDecl 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
  - locations
```
protected List<Location<XMLDocumentIdentifier>> locations
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":22.3-25, cf. this pretty print.)
    The type of this field is List<Location(maybe null)>(never null)
    Its value defaults to an empty collection.
    
    See Also:
    
    get_locations(), set_locations(java.util.List<eu.bandm.tools.message.Location<eu.bandm.tools.message.XMLDocumentIdentifier>>)
  - documentId
```
protected XMLDocumentIdentifier documentId
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":23.3-58, cf. this pretty print.)
    The type of this field is XMLDocumentIdentifier(maybe null)
    Its value defaults to null.
    
    See Also:
    
    get_documentId(), set_documentId(eu.bandm.tools.message.XMLDocumentIdentifier)
  - textDecl
```
protected DTD.TextDecl textDecl
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":24.3-55, cf. this pretty print.)
    The type of this field is DTD.TextDecl(maybe null)
    Its value defaults to null.
    
    See Also:
    
    get_textDecl(), set_textDecl(eu.bandm.tools.dtd.DTD.TextDecl)
  - markup
```
protected CheckedList<DTD.MarkupDecl> markup
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":25.3-55, cf. this pretty print.)
    The type of this field is CheckedList<DTD.MarkupDecl(never null)>(never null)
    Its value defaults to an empty collection.
    
    See Also:
    
    get_markup(), set_markup(eu.bandm.tools.umod.runtime.CheckedList<eu.bandm.tools.dtd.DTD.MarkupDecl>)
  - entityUsage
```
protected CheckedMultimap_RD<String,String> entityUsage
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":27.3-28, cf. this pretty print.)
    The type of this field is CheckedMultimap_RD<java.lang.String(never null),java.lang.String(never null)>(never null)
    Its value defaults to an empty collection.
    
    See Also:
    
    get_entityUsage(), set_entityUsage(eu.bandm.tools.umod.runtime.CheckedMultimap_RD<java.lang.String, java.lang.String>)
- Constructor Detail
  - Dtd
```
public Dtd(XMLDocumentIdentifier documentId)
```
    Constructor generated according to specification #1
    Constructor defined according to directive "C 1/..".
    
    Parameters:
    
    documentId - is copied to field documentId
  - Dtd
```
public Dtd()
```
    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 DTD.Dtd 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 ..
    ''/(textDecl?)/markup[/]
    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 DTD.Dtd 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_locations
```
public List<Location<XMLDocumentIdentifier>> get_locations()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":22.3-25, cf. this pretty print.)
    Generated getter method. @see #locations
    
    Returns:
    
    The current field value of type List<Location(maybe null)>(never null)
  - set_locations
```
public boolean set_locations(List<Location<XMLDocumentIdentifier>> val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":22.3-25, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type List<Location(maybe null)>(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    locations
  - descend_locations
```
public void descend_locations(DTD.MATCH_ONLY_00 visitor)
```
  - get_documentId
```
public XMLDocumentIdentifier get_documentId()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":23.3-58, cf. this pretty print.)
    Generated getter method. @see #documentId
    
    Returns:
    
    The current field value of type XMLDocumentIdentifier(maybe null)
  - set_documentId
```
public boolean set_documentId(XMLDocumentIdentifier val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":23.3-58, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type XMLDocumentIdentifier(maybe null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    documentId
  - get_textDecl
```
public DTD.TextDecl get_textDecl()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":24.3-55, cf. this pretty print.)
    Generated getter method. @see #textDecl
    
    Returns:
    
    The current field value of type DTD.TextDecl(maybe null)
  - set_textDecl
```
public boolean set_textDecl(DTD.TextDecl val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":24.3-55, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type DTD.TextDecl(maybe null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    textDecl
  - get_markup
```
public CheckedList<DTD.MarkupDecl> get_markup()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":25.3-55, cf. this pretty print.)
    Generated getter method. @see #markup
    
    Returns:
    
    The current field value of type CheckedList<DTD.MarkupDecl(never null)>(never null)
  - set_markup
```
public boolean set_markup(CheckedList<DTD.MarkupDecl> val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":25.3-55, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type CheckedList<DTD.MarkupDecl(never null)>(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    markup
  - descend_markup
```
public void descend_markup(DTD.MATCH_ONLY_00 visitor)
```
  - get_entityUsage
```
public CheckedMultimap_RD<String,String> get_entityUsage()
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":27.3-28, cf. this pretty print.)
    Generated getter method. @see #entityUsage
    
    Returns:
    
    The current field value of type CheckedMultimap_RD<java.lang.String(never null),java.lang.String(never null)>(never null)
  - set_entityUsage
```
public boolean set_entityUsage(CheckedMultimap_RD<String,String> val)
```
    Generated by umod; model author's documentation MISSING.
    (This definition has been created by UMod from the source at SYSTEM "DTD.umod":27.3-28, cf. this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type CheckedMultimap_RD<java.lang.String(never null),java.lang.String(never null)>(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    entityUsage
  - get_locations
```
public static Pattern<DTD.Dtd> get_locations(Pattern<? super List<Location<XMLDocumentIdentifier>>> 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 DTD.__Patterns.
  - get_documentId
```
public static Pattern<DTD.Dtd> get_documentId(Pattern<? super XMLDocumentIdentifier> 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 DTD.__Patterns.
  - get_textDecl
```
public static Pattern<DTD.Dtd> get_textDecl(Pattern<? super DTD.TextDecl> 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 DTD.__Patterns.
  - get_markup
```
public static Pattern<DTD.Dtd> get_markup(Pattern<? super CheckedList<DTD.MarkupDecl>> 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 DTD.__Patterns.
  - get_entityUsage
```
public static Pattern<DTD.Dtd> get_entityUsage(Pattern<? super CheckedMultimap_RD<String,String>> 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 DTD.__Patterns.

Class DTD.Dtd

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

locations

documentId

textDecl

markup

entityUsage

Constructor Detail

Dtd

Dtd

Method Detail

doclone

getFormatHint

format

initFrom

get_locations

set_locations

descend_locations

get_documentId

set_documentId

get_textDecl

set_textDecl

get_markup

set_markup

descend_markup

get_entityUsage

set_entityUsage

get_locations

get_documentId

get_textDecl

get_markup

get_entityUsage