Class Enumeration

All Implemented Interfaces:
Formattable, Serializable, Cloneable

public class Enumeration extends Definition
Generated by umod; model author's documentation MISSING.
(This definition has been created by UMod from the source at SYSTEM "D2d.umod":264.3-275.1, see this pretty print.)
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • doclone

      public Enumeration doclone()
      Clones this object. Method never fails, since Cloneable is known to be implemented.
      Overrides:
      doclone in class Definition
      Returns:
      a fresh copy.

    • getFormatHint

      public static String getFormatHint()
      Delivers the format specification from the umod source.
      The constant return value is ..
      ('enum' name '=' items{'"'$from'" =' $to}[,',' ,])/4>('with xmlrep' $switch xml_emptystructs{true:'empty' }xml_kind ('=' xml_tag ?)$switch xml_representation{ASIS:'as is',FIRSTID:'first name',NUMERIC:'numeric'})
      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 Definition
      Returns:
      a format that represents this object in a pretty-printable way
    • initFrom

      public Enumeration 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 Definition
    • get_sourceOrder

      public CheckedList<String> get_sourceOrder()
      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":265.9-29, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type CheckedList<java.lang.String(never null)>(never null)
      See Also:
    • set_sourceOrder

      public boolean set_sourceOrder(CheckedList<String> val)
      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":265.9-29, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type CheckedList<java.lang.String(never null)>(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:
    • get_items

      public CheckedMap_RD<String,Integer> get_items()
      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":266.9-35, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type CheckedMap_RD<java.lang.String(never null),java.lang.Integer(never null)>(never null)
      See Also:
    • set_items

      public boolean set_items(CheckedMap_RD<String,Integer> val)
      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":266.9-35, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type CheckedMap_RD<java.lang.String(never null),java.lang.Integer(never null)>(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:
    • put_items

      public void put_items(String key0, int 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 int(never null)
      See Also:
    • containsKey_items

      public boolean containsKey_items(String key0)
      Convenience un-Currying method.
      Returns:
      whether there exists a chain of collection objects to the given co-ordinate.
      See Also:

    • get_reverse

      public CheckedMap_RD<Integer,CheckedSet<String>> get_reverse()
      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":267.9-36, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type CheckedMap_RD<java.lang.Integer(never null),CheckedSet<java.lang.String(never null)>(never null)>(never null)
      See Also:
    • set_reverse

      public boolean set_reverse(CheckedMap_RD<Integer,CheckedSet<String>> val)
      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":267.9-36, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type CheckedMap_RD<java.lang.Integer(never null),CheckedSet<java.lang.String(never null)>(never null)>(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:
    • put_reverse

      public void put_reverse(int key0, CheckedSet<String> 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 CheckedSet<java.lang.String(never null)>(never null)
      See Also:
    • add_reverse

      public void add_reverse(int key0, String 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 java.lang.String(never null)
      See Also:
    • containsKey_reverse

      public boolean containsKey_reverse(int key0)
      Convenience un-Currying method.
      Returns:
      whether there exists a chain of collection objects to the given co-ordinate.
      See Also:

    • get_repr

      public CheckedMap_RD<Integer,String> get_repr()
      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":268.9-32, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type CheckedMap_RD<java.lang.Integer(never null),java.lang.String(never null)>(never null)
      See Also:
    • set_repr

      public boolean set_repr(CheckedMap_RD<Integer,String> val)
      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":268.9-32, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type CheckedMap_RD<java.lang.Integer(never null),java.lang.String(never null)>(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:
    • put_repr

      public void put_repr(int key0, String 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 java.lang.String(never null)
      See Also:
    • containsKey_repr

      public boolean containsKey_repr(int key0)
      Convenience un-Currying method.
      Returns:
      whether there exists a chain of collection objects to the given co-ordinate.
      See Also:

    • get_xml_representation

      public EnumRep get_xml_representation()
      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":269.9-39, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type EnumRep(never null)
      See Also:
    • set_xml_representation

      public boolean set_xml_representation(EnumRep val)
      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":269.9-39, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type EnumRep(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:
    • get_xml_emptystructs

      public boolean get_xml_emptystructs()
      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":270.9-33, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type boolean(never null)
      See Also:
    • set_xml_emptystructs

      public boolean set_xml_emptystructs(boolean val)
      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":270.9-33, see 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:
    • get_itemDocu

      Generated by umod; model author's documentation MISSING.
      (This definition has been created by UMod from the source at SYSTEM "D2d.umod":271.9-46, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type CheckedMap_RD<java.lang.Integer(never null),CheckedMap_RD<java.lang.String(never null),CheckedList<LocString(never null)>(never null)>(never null)>(never null)
      See Also:
    • set_itemDocu

      public boolean set_itemDocu(CheckedMap_RD<Integer,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":271.9-46, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type CheckedMap_RD<java.lang.Integer(never null),CheckedMap_RD<java.lang.String(never null),CheckedList<LocString(never null)>(never null)>(never null)>(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:
    • put_itemDocu

      public void put_itemDocu(int key0, 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:
      value - the new value of type CheckedMap_RD<java.lang.String(never null),CheckedList<LocString(never null)>(never null)>(never null)
      See Also:
    • put_itemDocu

      public void put_itemDocu(int key0, String key1, 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:
      value - the new value of type CheckedList<LocString(never null)>(never null)
      See Also:
    • add_itemDocu

      public void add_itemDocu(int key0, String key1, 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:
    • containsKey_itemDocu

      public boolean containsKey_itemDocu(int key0)
      Convenience un-Currying method.
      Returns:
      whether there exists a chain of collection objects to the given co-ordinate.
      See Also:

    • containsKey_itemDocu

      public boolean containsKey_itemDocu(int key0, String key1)
      Convenience un-Currying method.
      Returns:
      whether there exists a chain of collection objects to the given co-ordinate.
      See Also:

    • descend_itemDocu

      @Deprecated public void descend_itemDocu(MATCH_ONLY_00 visitor)
      Deprecated.
    • get_sourceOrder

      public static Pattern<Enumeration> get_sourceOrder(Pattern<? super CheckedList<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 __Patterns.
    • get_items

      public static Pattern<Enumeration> get_items(Pattern<? super CheckedMap_RD<String,Integer>> 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.
    • get_reverse

      public static Pattern<Enumeration> get_reverse(Pattern<? super CheckedMap_RD<Integer,CheckedSet<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 __Patterns.
    • get_repr

      public static Pattern<Enumeration> get_repr(Pattern<? super CheckedMap_RD<Integer,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 __Patterns.
    • get_xml_representation

      public static Pattern<Enumeration> get_xml_representation(Pattern<? super EnumRep> 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.
    • get_xml_emptystructs

      public static Pattern<Enumeration> get_xml_emptystructs(Pattern<? super Boolean> 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.
    • get_itemDocu

      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.