Package eu.bandm.tools.util3

Class ParameterExpanderOptions

java.lang.Object
eu.bandm.tools.option.runtime.Model<ParameterExpanderOptions>
eu.bandm.tools.util3.ParameterExpanderOptions
public class ParameterExpanderOptions extends Model<ParameterExpanderOptions>
Generated source for command line processing.
(A parallel GUI class has not been generated. The normal way of operation is:
  1. Create a fresh instance by the only constructor ParameterExpanderOptions().
  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.

There have been description texts only in one language, namely en.

The usage() method will show this screen: 

 ======
 USAGE:
 ======
 -0 / --inputFiles     ( uri(="") )+
 List of input files. Each file must contain the substitution character for 
    deriving the name of the output file.
 -s / --substitutions  ( string(="") string(="") )+
 Pairs of substitutions, directly given as command line parameters. 
    Additionally to the file inputs, and valid for all qualifiers.
 -S / --substitutionFiles  ( uri(="") )+
 List of names of files, containing substitutions. Their format is the Java 
    standard "java.util.Property" file.
 --escape         string(="$")
 Lead in character for marking the start of a text to substitute.
 --encoding       string(="UTF-8")
 Character encoding used for input of source files and output of targets. 
 --placeholder    string(="")
 String to be replaced in the name of the input file and the substitution 
    files. If not given, no such replacement is done. Else at least one 
    fileNameQualifier must be given.
 --qualifiers     ( string(="") )+
 To be inserted in the name of the input file for the name of the output file,
    and in the name of the substitution file. This list must be non-empty if a
    placeholder is defined.
 --targetdir      uri(="")
 If set, the target files will be generated in this directory instead of that 
    of the input files.
Created on 2024-09-15_20h21m48
by program bandm/metatools/option/compiler, version 2.1
command line =
java bandm/metatools/option/compiler ParameterExpanderOptions.xml eu.bandm.tools.util3 ParameterExpanderOptions $(HOME)/metatools/src

  • Field Details

  • Constructor Details

    • ParameterExpanderOptions

      public ParameterExpanderOptions()

  • Method Details

    • makeDefaultInstance

      public ParameterExpanderOptions 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<ParameterExpanderOptions>

    • 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<ParameterExpanderOptions>

    • has_inputFiles

      @Deprecated public boolean has_inputFiles()
      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_inputFiles().

    • get_inputFiles

      public List<ParameterExpanderOptions.Values_inputFiles> get_inputFiles()
      Getter method for all repetition groups of option inputFiles.
      This option indicates: List of input files. Each file must contain the substitution character for deriving the name of the output file.

      The format of this option on the command line is 
       
   -0 / --inputFiles     ( uri(="") )+

    • get_inputFiles_0

      public String get_inputFiles_0(int index)
      Getter method for the only repeated argument of option inputFiles. For details of this option see the method get_inputFiles().
      Parameters:
      index - the index of the repetition group, zero based.

    • has_substitutions

      @Deprecated public boolean has_substitutions()
      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_substitutions().

    • get_substitutions

      public List<ParameterExpanderOptions.Values_substitutions> get_substitutions()
      Getter method for all repetition groups of option substitutions.
      This option indicates: Pairs of substitutions, directly given as command line parameters. Additionally to the file inputs, and valid for all qualifiers.

      The format of this option on the command line is 
       
   -s / --substitutions  ( string(="") string(="") )+

    • get_substitutions_0

      public String get_substitutions_0(int index)
      Getter method for the 0th in a group of repeated arguments of option substitutions. For details of this option see the method get_substitutions().
      Parameters:
      index - the index of the repetition group, zero based.

    • get_substitutions_1

      public String get_substitutions_1(int index)
      Getter method for the 1st in a group of repeated arguments of option substitutions. For details of this option see the method get_substitutions().
      Parameters:
      index - the index of the repetition group, zero based.

    • has_substitutionFiles

      @Deprecated public boolean has_substitutionFiles()
      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_substitutionFiles().

    • get_substitutionFiles

      public List<ParameterExpanderOptions.Values_substitutionFiles> get_substitutionFiles()
      Getter method for all repetition groups of option substitutionFiles.
      This option indicates: List of names of files, containing substitutions. Their format is the Java standard "java.util.Property" file.

      The format of this option on the command line is 
       
   -S / --substitutionFiles  ( uri(="") )+

    • get_substitutionFiles_0

      public String get_substitutionFiles_0(int index)
      Getter method for the only repeated argument of option substitutionFiles. For details of this option see the method get_substitutionFiles().
      Parameters:
      index - the index of the repetition group, zero based.

    • has_escape

      @Deprecated public boolean has_escape()
      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_escape_0().

    • get_escape_0

      public String get_escape_0()
      Getter method for the only argument of option escape.
      This option indicates: Lead in character for marking the start of a text to substitute.

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

    • has_encoding

      @Deprecated public boolean has_encoding()
      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_encoding_0().

    • get_encoding_0

      public String get_encoding_0()
      Getter method for the only argument of option encoding.
      This option indicates: Character encoding used for input of source files and output of targets.

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

    • has_placeholder

      @Deprecated public boolean has_placeholder()
      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_placeholder_0().

    • get_placeholder_0

      public String get_placeholder_0()
      Getter method for the only argument of option placeholder.
      This option indicates: String to be replaced in the name of the input file and the substitution files. If not given, no such replacement is done. Else at least one fileNameQualifier must be given.

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

    • has_qualifiers

      @Deprecated public boolean has_qualifiers()
      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_qualifiers().

    • get_qualifiers

      public List<ParameterExpanderOptions.Values_qualifiers> get_qualifiers()
      Getter method for all repetition groups of option qualifiers.
      This option indicates: To be inserted in the name of the input file for the name of the output file, and in the name of the substitution file. This list must be non-empty if a placeholder is defined.

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

    • get_qualifiers_0

      public String get_qualifiers_0(int index)
      Getter method for the only repeated argument of option qualifiers. For details of this option see the method get_qualifiers().
      Parameters:
      index - the index of the repetition group, zero based.

    • has_targetdir

      @Deprecated public boolean has_targetdir()
      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_targetdir_0().

    • get_targetdir_0

      public String get_targetdir_0()
      Getter method for the only argument of option targetdir.
      This option indicates: If set, the target files will be generated in this directory instead of that of the input files.

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

    • 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<ParameterExpanderOptions>

    • usage

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

    • 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<ParameterExpanderOptions>

    • 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<ParameterExpanderOptions>
      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<ParameterExpanderOptions>
      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<ParameterExpanderOptions>

    • 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<ParameterExpanderOptions>

    • _finalCheck

      protected void _finalCheck()
      Description copied from class: Model
      Callback, overridden by compiled code.
      Specified by:
      _finalCheck in class Model<ParameterExpanderOptions>

    • _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<ParameterExpanderOptions>

    • _getRedundantOptions

      public String _getRedundantOptions()
      Description copied from class: Model
      Callback, overridden by compiled code.
      Specified by:
      _getRedundantOptions in class Model<ParameterExpanderOptions>