Package eu.bandm.music.applications.tiTuning

Class Options

java.lang.Object
eu.bandm.tools.option.runtime.Model<Options>
eu.bandm.music.applications.tiTuning.Options
@Generated(generator="eu.bandm.tools.option", version="", timestamp="2025-07-30_06h45m17") public class Options extends Model<Options>
Generated source for command line processing.
The parallel GUI class is GeneratedGui.
The normal way of operation is:
  1. Create a fresh instance by the only constructor Options().
  2. Analyse command line by invoking Model.parse(String[],MessageReceiver,String)
  3. Inquire whether a particular option X has been set on the commandline by invoking has_[X]().
  4. The arguments of each option are determined by a sequence of types: first a leading sequence, values for which appear exactly once, followed by a sequence which may be repeated. Both type sequences may be empty.
    Inquire value of the options n-th argument in the fixed, leading argument sequence by get_[X]_[n]().
  5. Inquire value of the options n-th argument in the k-th repetition group by get_[X]_[n](k).

If anything went wrong in parsing, errors have been sent to the MessageReceiver. Then further analysis methods can be applied (Model.getParsingProtocol(), Model.getMissingOptions(), Model.usage(), etc.)
For further details. please see the documentation of the methods inherited from the superclass Model and the option compiler's user documentation.

Here is the source text.

Internationalization

The documentation texts in the option definition file are multi-lingual. There are entries in the languages de and en.
As default language the English language has been chosen, because it is lingua franca of computer science.

The usage() method will show this screen: 

 ======
 USAGE:
 ======
 -v / --version        (bool)?(=true iff present)
 show version number
 --noGreeting     (bool)?(=true iff present)
 suppress the display of the first "greeting" window
 --interactive    (bool)?(=true iff present)
 start GUI even with command line arguments
 --help           (bool)?(=true iff present)
 print help text to console
 --jukebox        jukebox(=null)
 Select the example song.
 --tuning         float(=0.5)
 R factor, see documentation.
 
 jukebox: 
 *         Farewell:    From 17th century at the Irish West coast.
 *             Heyr:    From 17th century at the Norwegian  West coast.
 *         MansRoad:    From 17th century at the Norwegian  West coast.
 *   LimerickSuiteMulti:    From 17th century at the Norwegian  West coast.
 *          Sklaven:    From 17th century at the Norwegian  West coast.
 *   HerzliebsterWein:    From 17th century at the Norwegian  West coast.
 *             Dido:    From 17th century at the Norwegian  West coast.
Generated on 2025-07-30_06h45m17
by program bandm/metatools/option/compiler, version
command line =
java bandm/metatools/option/compiler options.xml eu.bandm.music.applications.tiTuning Options GeneratedGui /mnt/c/Users/post/Documents/sig/src

  • Field Details

    • has_version

      protected boolean has_version

    • value_version_0

      protected boolean value_version_0

    • has_noGreeting

      protected boolean has_noGreeting

    • value_noGreeting_0

      protected boolean value_noGreeting_0

    • has_interactive

      protected boolean has_interactive

    • value_interactive_0

      protected boolean value_interactive_0

    • has_help

      protected boolean has_help

    • value_help_0

      protected boolean value_help_0

    • has_jukebox

      protected boolean has_jukebox

    • value_jukebox_0

      protected Options.jukebox value_jukebox_0

    • has_tuning

      protected boolean has_tuning

    • value_tuning_0

      protected double value_tuning_0

  • Constructor Details

    • Options

      public Options()

  • Method Details

    • makeDefaultInstance

      public Options makeDefaultInstance()
      Description copied from class: eu.bandm.tools.option.runtime.Model
      Overriden by the generated code to make a constructor call of the actual Model (sub-)class.
      Specified by:
      makeDefaultInstance in class Model<Options>

    • checkActive

      protected void checkActive()
      Description copied from class: eu.bandm.tools.option.runtime.Model
      The generated code will evaluate all conditions to activate/deactive options in the GUI.
      Specified by:
      checkActive in class Model<Options>

    • has_version

      @Deprecated public boolean has_version()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_version_0().

    • get_version_0

      public boolean get_version_0()
      Getter method for the 0th argument of option version.
      This option indicates: show version number.

      The format of this option on the command line is 
       
   -v / --version        (bool)?(=true iff present)

    • has_noGreeting

      @Deprecated public boolean has_noGreeting()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_noGreeting_0().

    • get_noGreeting_0

      public boolean get_noGreeting_0()
      Getter method for the 0th argument of option noGreeting.
      This option indicates: suppress the display of the first "greeting" window.

      The format of this option on the command line is 
       
        --noGreeting     (bool)?(=true iff present)

    • has_interactive

      @Deprecated public boolean has_interactive()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_interactive_0().

    • get_interactive_0

      public boolean get_interactive_0()
      Getter method for the 0th argument of option interactive.
      This option indicates: start GUI even with command line arguments.

      The format of this option on the command line is 
       
        --interactive    (bool)?(=true iff present)

    • has_help

      @Deprecated public boolean has_help()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_help_0().

    • get_help_0

      public boolean get_help_0()
      Getter method for the 0th argument of option help.
      This option indicates: print help text to console.

      The format of this option on the command line is 
       
        --help           (bool)?(=true iff present)

    • has_jukebox

      @Deprecated public boolean has_jukebox()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_jukebox_0().

    • get_jukebox_0

      public Options.jukebox get_jukebox_0()
      Getter method for the only argument of option jukebox.
      This option indicates: Select the example song.

      The format of this option on the command line is 
       
        --jukebox        jukebox(=null)

    • has_tuning

      @Deprecated public boolean has_tuning()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_tuning_0().

    • get_tuning_0

      public double get_tuning_0()
      Getter method for the only argument of option tuning.
      This option indicates: R factor, see documentation.

      The format of this option on the command line is 
       
        --tuning         float(=0.5)

    • serialize

      public String serialize()
      Description copied from class: eu.bandm.tools.option.runtime.Model
      Called to generate a String representation of the model's state. Code is overridden by the compiled code.
      Specified by:
      serialize in class Model<Options>

    • usage

      public void usage(PrintStream pr)
      Print usage information in the default language.
      Specified by:
      usage in class Model<Options>

    • usage

      public void usage(PrintStream pr, String lang)
      Print usage information in the requested language. Falls back to default language, if that language is not supported.
      Specified by:
      usage in class Model<Options>

    • usage_de

      public void usage_de()
      Print usage information in the language 'de' on System.err.

    • usage_de

      public void usage_de(PrintStream pr)
      Print usage information in the language 'de'.

    • usage_en

      public void usage_en()
      Print usage information in the language 'en' on System.err.

    • usage_en

      public void usage_en(PrintStream pr)
      Print usage information in the language 'en'.

    • parseAbbrev

      protected void parseAbbrev(String select)
      Description copied from class: eu.bandm.tools.option.runtime.Model
      Callback, overridden by compiled code, which realizes a switch over all one character option names. The generated code calls the argument parsers and stores the resulting values to the model's fields.
      Specified by:
      parseAbbrev in class Model<Options>
      Parameters:
      select - the one-character option name, as parsed by this code.

    • parseName

      protected void parseName(String select)
      Description copied from class: eu.bandm.tools.option.runtime.Model
      Callback, overridden by compiled code, which realizes a switch over all long option names. The generated code calls the argument parsers and stores the resulting values to the model's fields.
      Specified by:
      parseName in class Model<Options>
      Parameters:
      select - the multi-character option name, as parsed by this code.

    • numberOfPositionals

      protected int numberOfPositionals()
      Description copied from class: eu.bandm.tools.option.runtime.Model
      The generated code will return the number of positional parameters.
      Specified by:
      numberOfPositionals in class Model<Options>

    • parsePositionals

      protected void parsePositionals()
      Description copied from class: eu.bandm.tools.option.runtime.Model
      Callback, overridden by compiled code, which calls one after the other the positional parameters. Each of them corresponds to an implicit option (with short names "-0", "-1", "-2", ...). These can also be defined explicitly, e.g. be given a long name, etc. Anyhow, they can be set explicitly by their short name. If one single positional option is given explicitly, the implicit parsing of the others is suppressed and this code will not be called.
      Specified by:
      parsePositionals in class Model<Options>

    • _finalCheck

      protected void _finalCheck()
      Description copied from class: eu.bandm.tools.option.runtime.Model
      Callback, overridden by compiled code.
      Specified by:
      _finalCheck in class Model<Options>

    • _getMissingOptions

      public String _getMissingOptions()
      Description copied from class: eu.bandm.tools.option.runtime.Model
      Is overridden in the generated code and concatenates the "longest names" of all otions marked as required, but not present in the parsed input. Length==0 iff none is missing. Cf "sourcedtd required='yes'" in tools/tdom_withOptions/Options.xml
      Specified by:
      _getMissingOptions in class Model<Options>

    • _getRedundantOptions

      public String _getRedundantOptions()
      Description copied from class: eu.bandm.tools.option.runtime.Model
      Callback, overridden by compiled code.
      Specified by:
      _getRedundantOptions in class Model<Options>