Package eu.bandm.tools.util3

Class JarLinkerOptions

java.lang.Object
eu.bandm.tools.option.runtime.Model<JarLinkerOptions>
eu.bandm.tools.util3.JarLinkerOptions
public class JarLinkerOptions extends Model<JarLinkerOptions>
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 JarLinkerOptions().
  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:
 ======
 --main           ( string(="") )+
 the name(s) of the main class(es) which define reachability. The very first 
    will be the *main*  class in the jar file's Manifest. 
 --exclude        ( string(="") )+
 names of packages and subtrees to exclude. "a.b.c" is a package all classes 
    in which will not be included. "a.b..." (three triling dots) is a subtree:
    all packages with this prefix will be excluded. 
 --inputs         ( uri(="") )+
 the binary input sources in which to search for classes (directories or jar 
 files)
 --output         uri(="")
 the path to the jar file to generate
 --debug          int(=0)
 the verbosity
 --ressourceDirs  ( uri(="") string(="") )*
 pair of source/target, where to move directories of ressources The first is 
    the source position in the file system, the second is a directory in the 
    generated jar file.
 --manifest       uri(="")
 base manifest file
 --seal           boolean(=false)
 whether to seal all packages
Created on 2024-03-03_16h27m46
by program bandm/metatools/option/compiler, version 2.1
command line =
bandm/metatools/option/compiler JarLinkerOptions.xml eu.bandm.tools.util3 JarLinkerOptions $(HOME)/metatools/src

  • Field Details

  • Constructor Details

    • JarLinkerOptions

      public JarLinkerOptions()

  • Method Details

    • makeDefaultInstance

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

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

    • has_main

      @Deprecated public boolean has_main()
      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_main().

    • get_main

      public List<JarLinkerOptions.Values_main> get_main()
      Getter method for all repetition groups of option main.
      This option indicates: the name(s) of the main class(es) which define reachability. The very first will be the *main* class in the jar file's Manifest.

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

    • get_main_0

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

    • has_exclude

      @Deprecated public boolean has_exclude()
      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_exclude().

    • get_exclude

      public List<JarLinkerOptions.Values_exclude> get_exclude()
      Getter method for all repetition groups of option exclude.
      This option indicates: names of packages and subtrees to exclude. "a.b.c" is a package all classes in which will not be included. "a.b..." (three triling dots) is a subtree: all packages with this prefix will be excluded.

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

    • get_exclude_0

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

    • has_inputs

      @Deprecated public boolean has_inputs()
      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_inputs().

    • get_inputs

      public List<JarLinkerOptions.Values_inputs> get_inputs()
      Getter method for all repetition groups of option inputs.
      This option indicates: the binary input sources in which to search for classes (directories or jar files).

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

    • get_inputs_0

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

    • has_output

      @Deprecated public boolean has_output()
      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_output_0().

    • get_output_0

      public String get_output_0()
      Getter method for the only argument of option output.
      This option indicates: the path to the jar file to generate.

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

    • has_debug

      @Deprecated public boolean has_debug()
      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_debug_0().

    • get_debug_0

      public int get_debug_0()
      Getter method for the only argument of option debug.
      This option indicates: the verbosity.

      The format of this option on the command line is 
       
        --debug          int(=0)

    • has_ressourceDirs

      @Deprecated public boolean has_ressourceDirs()
      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_ressourceDirs().

    • get_ressourceDirs

      public List<JarLinkerOptions.Values_ressourceDirs> get_ressourceDirs()
      Getter method for all repetition groups of option ressourceDirs.
      This option indicates: pair of source/target, where to move directories of ressources The first is the source position in the file system, the second is a directory in the generated jar file.

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

    • get_ressourceDirs_0

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

    • get_ressourceDirs_1

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

    • has_manifest

      @Deprecated public boolean has_manifest()
      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_manifest_0().

    • get_manifest_0

      public String get_manifest_0()
      Getter method for the only argument of option manifest.
      This option indicates: base manifest file.

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

    • has_seal

      @Deprecated public boolean has_seal()
      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_seal_0().

    • get_seal_0

      public boolean get_seal_0()
      Getter method for the only argument of option seal.
      This option indicates: whether to seal all packages.

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

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

    • usage

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

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

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

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

    • _finalCheck

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

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

    • _getRedundantOptions

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