Package eu.bandm.tscore.model

Class Container

java.lang.Object
eu.bandm.tscore.model.Container
All Implemented Interfaces:
Formattable, Cloneable
Direct Known Subclasses:
Part, TimeScape, Vox
public class Container extends Object implements Cloneable, Formattable
Abstract base class of all event collections, which additionally carry some non-temporal ("meta") attributes.
(This definition has been created by UMod from the source at SYSTEM "tscore.umod":18.3-39.5, see this pretty print.)

  • Field Details

  • Constructor Details

    • Container

      public Container()
      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 Details

    • doclone

      public Container 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
      Returns:
      a format that represents this object in a pretty-printable way

    • initFrom

      public Container 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_conform

      public String get_conform()
      Names a Java class which implements the rules for parsing and evaluating.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":21.5-22.5, see this pretty print.)
      Generated getter method. @see #conform
      Returns:
      The current field value of type java.lang.String(maybe null)

    • set_conform

      public boolean set_conform(String val)
      Names a Java class which implements the rules for parsing and evaluating.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":21.5-22.5, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type java.lang.String(maybe null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:

    • get_context

      public Container get_context()

    • get_timelesslist

      public CheckedList<Timeless> get_timelesslist()
      Collects time-less attributes of this container and its contents. Typical example keys are in MetaKeys
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":30.5-31.5, see this pretty print.)
      Generated getter method. @see #timelesslist
      Returns:
      The current field value of type CheckedList<Timeless(never null)>(never null)

    • set_timelesslist

      public boolean set_timelesslist(CheckedList<Timeless> val)
      Collects time-less attributes of this container and its contents. Typical example keys are in MetaKeys
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":30.5-31.5, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type CheckedList<Timeless(never null)>(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:

    • descend_timelesslist

      @Deprecated public void descend_timelesslist(MATCH_ONLY_00 visitor)
      Deprecated.

    • get_voices

      public CheckedMap_RD<String,Vox> get_voices()
      Not used in Vox; in TimeScape it holds only timeless parameters for subsequent voices in parts with same name. In parts it holds "real" voices with events.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":34.5-35.5, see this pretty print.)
      Generated getter method. @see #voices
      Returns:
      The current field value of type CheckedMap_RD<java.lang.String(never null),Vox(never null)>(never null)

    • set_voices

      public boolean set_voices(CheckedMap_RD<String,Vox> val)
      Not used in Vox; in TimeScape it holds only timeless parameters for subsequent voices in parts with same name. In parts it holds "real" voices with events.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":34.5-35.5, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type CheckedMap_RD<java.lang.String(never null),Vox(never null)>(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:

    • put_voices

      public void put_voices(String key0, Vox 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 Vox(never null)
      See Also:

    • containsKey_voices

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

    • descend_voices

      @Deprecated public void descend_voices(MATCH_ONLY_00 visitor)
      Deprecated.

    • get_voicesBySource

      public CheckedList<Vox> get_voicesBySource()
      All voices appearing in the score, in source order of their first appearance.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":38.5-39.5, see this pretty print.)
      Generated getter method. @see #voicesBySource
      Returns:
      The current field value of type CheckedList<Vox(never null)>(never null)

    • set_voicesBySource

      public boolean set_voicesBySource(CheckedList<Vox> val)
      All voices appearing in the score, in source order of their first appearance.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":38.5-39.5, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type CheckedList<Vox(never null)>(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:

    • descend_voicesBySource

      @Deprecated public void descend_voicesBySource(MATCH_ONLY_00 visitor)
      Deprecated.