Package eu.bandm.tools.d2d2.demo

Class Options

java.lang.Object
eu.bandm.tools.option.runtime.Model<Options>
eu.bandm.tools.d2d2.demo.Options
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: 

 =============================
 Roles of the input controls :
 =============================
 --fromDisk       boolean(=false)
 Whenever a processing is initiated, the current state of the source files are
    read and the editor buffers will be overwritten.. 
 --verbosity      int(=1)
 Controls the amount of tracing messages. 
 --toDisk         boolean(=false)
 Whenever a processing is executed, the results re written to disc files in 
    the selected directory. 
 --directory      uri(="")
 Where to read and write the text files 
 COND=(fromDisk_0∨toDisk_0)
 --stem           string(="")
 Common name of all data files involved. Only their extensions differ. (The 
     module definition file, if any, has the name of the module as its stem)
Created on 2024-09-22_11h19m36
by program bandm/metatools/option/compiler, version 2.1
command line =
java bandm/metatools/option/compiler options.xml eu.bandm.tools.d2d2.demo Options GeneratedGui $(HOME)/metatools/src

  • Field Details

    • has_fromDisk

      protected boolean has_fromDisk

    • value_fromDisk_0

      protected boolean value_fromDisk_0

    • has_verbosity

      protected boolean has_verbosity

    • value_verbosity_0

      protected int value_verbosity_0

    • has_toDisk

      protected boolean has_toDisk

    • value_toDisk_0

      protected boolean value_toDisk_0

    • has_directory

      protected boolean has_directory

    • value_directory_0

      protected String value_directory_0

    • active_directory

      protected boolean active_directory

    • has_stem

      protected boolean has_stem

    • value_stem_0

      protected String value_stem_0

  • Constructor Details

    • Options

      public Options()

  • Method Details

    • makeDefaultInstance

      public Options makeDefaultInstance()
      Description copied from class: 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: Model
      The generated code will evaluate all conditions to activate/deactive options in the GUI.
      Specified by:
      checkActive in class Model<Options>

    • has_fromDisk

      @Deprecated public boolean has_fromDisk()
      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_fromDisk_0().

    • get_fromDisk_0

      public boolean get_fromDisk_0()
      Getter method for the only argument of option fromDisk.
      This option indicates: Whenever a processing is initiated, the current state of the source files are read and the editor buffers will be overwritten..

      The format of this option on the command line is 
       
        --fromDisk       boolean(=false)

    • has_verbosity

      @Deprecated public boolean has_verbosity()
      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_verbosity_0().

    • get_verbosity_0

      public int get_verbosity_0()
      Getter method for the only argument of option verbosity.
      This option indicates: Controls the amount of tracing messages.

      The format of this option on the command line is 
       
        --verbosity      int(=1)

    • has_toDisk

      @Deprecated public boolean has_toDisk()
      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_toDisk_0().

    • get_toDisk_0

      public boolean get_toDisk_0()
      Getter method for the only argument of option toDisk.
      This option indicates: Whenever a processing is executed, the results re written to disc files in the selected directory.

      The format of this option on the command line is 
       
        --toDisk         boolean(=false)

    • has_directory

      @Deprecated public boolean has_directory()
      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_directory_0().

    • get_directory_0

      public String get_directory_0()
      Getter method for the only argument of option directory.
      This option indicates: Where to read and write the text files.

      The format of this option on the command line is 
       
        --directory      uri(="")

    • has_stem

      @Deprecated public boolean has_stem()
      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_stem_0().

    • get_stem_0

      public String get_stem_0()
      Getter method for the only argument of option stem.
      This option indicates: Common name of all data files involved. Only their extensions differ. (The module definition file, if any, has the name of the module as its stem).

      The format of this option on the command line is 
       
        --stem           string(="")

    • serialize

      public String serialize()
      Description copied from class: 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: 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: 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: 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: 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: Model
      Callback, overridden by compiled code.
      Specified by:
      _finalCheck in class Model<Options>

    • _getMissingOptions

      public String _getMissingOptions()
      Description copied from class: 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: Model
      Callback, overridden by compiled code.
      Specified by:
      _getRedundantOptions in class Model<Options>