Options (BandM metatools API doc)

java.lang.Object
- <any>
- - eu.bandm.tools.umod.Options

public class Options
extends <any>

Generated source for command line processing.
The parallel GUI class is GuiOptions.
The normal way of operation is:

Create a fresh instance by the only constructor Options().
Analyse command line by invoking #parse(String[],MessageReceiver)
Inquire whether a particular option X has been set on the commandline by invoking has_[X]().
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]().
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 (#getParsingProtocol(), #getMissingOptions(), #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:
 ======
 --------------------------------
 Model substantial information
 --------------------------------
 -0 / --sourceroot     uri(="")
 file system directory which is the root of the source code hierarchie
 -1 / --packagename    string(="")
 name of the package of the generated model class
 -2 / --sourcefiles    ( uri(="") )+
 source files containing the model declaration
 -m / --monolithic     boolean(=true)
 generate a single class instead of a package
 -p / --targetclasspath  ( uri(="") )*
 classpath to search for existing class files, if different from current 
    classpath. NOT YET ACTIVE!! 
 -------------------------------
 Code generation modification
 -------------------------------
 --floatNotDouble  boolean(=false)
 implement the umod type "float" not by doubles but by floats. 
 -G / --getterfunctions  boolean(=false)
 whether to generate getter function objects DEPRECATED
 -S / --setterfunctions  boolean(=false)
 whether to generate setter function objects DEPRECATED
 -x / --xmlgen         boolean(=true)
 whether to generate SAX de-/serialization
 -s / --swingtree      boolean(=false)
 whether to generate a swing tree visualization
 --patterns       (bool)?(=true iff present)
 Generate methods for lifting and applying "Paisley" patterns to model 
    elements and their fields
 --constructorsPre20181214  (bool)?(=true iff present)
 Use old constructor code generation scheme, prior to 20181214 redefinition.
 -V / --visitordebug   boolean(=false)
 whether to add logging code to the generated visitors
 -v / --visitoroptimize  boolean(=false)
 whether to cut superfluous descends
 --rewriterwarnings  (bool)?(=true iff present)
 whether all warnings from rewriter code shall be printed, even when the code 
    generation algorithm takes the responsibility. 
 -w / --linewidth      int(=80)
 line width for the formatting of the generated source code

Created on 2022-06-30_15h10m43
by program bandm/metatools/option/compiler, version 2.1
command line =
bandm/metatools/option/compiler umodOptions.xml eu.bandm.tools.umod Options GuiOptions $(HOME)/metatools/src

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`Options.Descriptions` Programmatically generated catalog of translations.
`class`	`Options.Values_sourcefiles` One instance realizes one repeated argument group of option `sourcefiles`.
`class`	`Options.Values_targetclasspath` One instance realizes one repeated argument group of option `targetclasspath`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`has_constructorsPre20181214`
`protected boolean`	`has_floatNotDouble`
`protected boolean`	`has_getterfunctions`
`protected boolean`	`has_linewidth`
`protected boolean`	`has_monolithic`
`protected boolean`	`has_packagename`
`protected boolean`	`has_patterns`
`protected boolean`	`has_rewriterwarnings`
`protected boolean`	`has_setterfunctions`
`protected boolean`	`has_sourcefiles`
`protected boolean`	`has_sourceroot`
`protected boolean`	`has_swingtree`
`protected boolean`	`has_targetclasspath`
`protected boolean`	`has_visitordebug`
`protected boolean`	`has_visitoroptimize`
`protected boolean`	`has_xmlgen`
`protected List<Options.Values_sourcefiles>`	`repvalues_sourcefiles`
`protected List<Options.Values_targetclasspath>`	`repvalues_targetclasspath`
`Function<Options.Values_sourcefiles,String>`	`serialize_sourcefiles`
`Function<Options.Values_targetclasspath,String>`	`serialize_targetclasspath`
`protected boolean`	`value_constructorsPre20181214_0`
`protected boolean`	`value_floatNotDouble_0`
`protected boolean`	`value_getterfunctions_0`
`protected int`	`value_linewidth_0`
`protected boolean`	`value_monolithic_0`
`protected String`	`value_packagename_0`
`protected boolean`	`value_patterns_0`
`protected boolean`	`value_rewriterwarnings_0`
`protected boolean`	`value_setterfunctions_0`
`protected String`	`value_sourceroot_0`
`protected boolean`	`value_swingtree_0`
`protected boolean`	`value_visitordebug_0`
`protected boolean`	`value_visitoroptimize_0`
`protected boolean`	`value_xmlgen_0`

Constructor Summary

Constructors
Constructor and Description

Options()

Constructors
Constructor and Description
`Options()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`_finalCheck()`
`String`	`_getMissingOptions()`
`String`	`_getRedundantOptions()`
`protected void`	`checkActive()`
`boolean`	`get_constructorsPre20181214_0()` Getter method for the 0th argument of option `constructorsPre20181214`.
`boolean`	`get_floatNotDouble_0()` Getter method for the only argument of option `floatNotDouble`.
`boolean`	`get_getterfunctions_0()` Getter method for the only argument of option `getterfunctions`.
`int`	`get_linewidth_0()` Getter method for the only argument of option `linewidth`.
`boolean`	`get_monolithic_0()` Getter method for the only argument of option `monolithic`.
`String`	`get_packagename_0()` Getter method for the only argument of option `packagename`.
`boolean`	`get_patterns_0()` Getter method for the only argument of option `patterns`.
`boolean`	`get_rewriterwarnings_0()` Getter method for the only argument of option `rewriterwarnings`.
`boolean`	`get_setterfunctions_0()` Getter method for the only argument of option `setterfunctions`.
`String`	`get_sourcefiles_0(int index)` Getter method for the only repeated argument of option `sourcefiles`.
`List<Options.Values_sourcefiles>`	`get_sourcefiles()` Getter method for all repetition groups of option `sourcefiles`.
`String`	`get_sourceroot_0()` Getter method for the only argument of option `sourceroot`.
`boolean`	`get_swingtree_0()` Getter method for the only argument of option `swingtree`.
`String`	`get_targetclasspath_0(int index)` Getter method for the only repeated argument of option `targetclasspath`.
`List<Options.Values_targetclasspath>`	`get_targetclasspath()` Getter method for all repetition groups of option `targetclasspath`.
`boolean`	`get_visitordebug_0()` Getter method for the only argument of option `visitordebug`.
`boolean`	`get_visitoroptimize_0()` Getter method for the only argument of option `visitoroptimize`.
`boolean`	`get_xmlgen_0()` Getter method for the only argument of option `xmlgen`.
`boolean`	`has_constructorsPre20181214()` Deprecated.
`boolean`	`has_floatNotDouble()` Deprecated.
`boolean`	`has_getterfunctions()` Deprecated.
`boolean`	`has_linewidth()` Deprecated.
`boolean`	`has_monolithic()` Deprecated.
`boolean`	`has_packagename()` Deprecated.
`boolean`	`has_patterns()` Deprecated.
`boolean`	`has_rewriterwarnings()` Deprecated.
`boolean`	`has_setterfunctions()` Deprecated.
`boolean`	`has_sourcefiles()` Deprecated.
`boolean`	`has_sourceroot()` Deprecated.
`boolean`	`has_swingtree()` Deprecated.
`boolean`	`has_targetclasspath()` Deprecated.
`boolean`	`has_visitordebug()` Deprecated.
`boolean`	`has_visitoroptimize()` Deprecated.
`boolean`	`has_xmlgen()` Deprecated.
`Options`	`makeDefaultInstance()`
`protected int`	`numberOfPositionals()`
`protected void`	`parseAbbrev(String select)`
`protected void`	`parseName(String select)`
`protected void`	`parsePositionals()`
`String`	`serialize()`
`void`	`usage_en()` Print usage information in the language 'en' on System.err.
`void`	`usage_en(PrintStream pr)` Print usage information in the language 'en'.
`void`	`usage(PrintStream pr)` Print usage information in the default language.
`void`	`usage(PrintStream pr, String lang)` Print usage information in the requested language.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - has_sourceroot
```
protected boolean has_sourceroot
```
  - value_sourceroot_0
```
protected String value_sourceroot_0
```
  - has_packagename
```
protected boolean has_packagename
```
  - value_packagename_0
```
protected String value_packagename_0
```
  - has_sourcefiles
```
protected boolean has_sourcefiles
```
  - repvalues_sourcefiles
```
protected List<Options.Values_sourcefiles> repvalues_sourcefiles
```
  - serialize_sourcefiles
```
public final Function<Options.Values_sourcefiles,String> serialize_sourcefiles
```
  - has_monolithic
```
protected boolean has_monolithic
```
  - value_monolithic_0
```
protected boolean value_monolithic_0
```
  - has_targetclasspath
```
protected boolean has_targetclasspath
```
  - repvalues_targetclasspath
```
protected List<Options.Values_targetclasspath> repvalues_targetclasspath
```
  - serialize_targetclasspath
```
public final Function<Options.Values_targetclasspath,String> serialize_targetclasspath
```
  - has_floatNotDouble
```
protected boolean has_floatNotDouble
```
  - value_floatNotDouble_0
```
protected boolean value_floatNotDouble_0
```
  - has_getterfunctions
```
protected boolean has_getterfunctions
```
  - value_getterfunctions_0
```
protected boolean value_getterfunctions_0
```
  - has_setterfunctions
```
protected boolean has_setterfunctions
```
  - value_setterfunctions_0
```
protected boolean value_setterfunctions_0
```
  - has_xmlgen
```
protected boolean has_xmlgen
```
  - value_xmlgen_0
```
protected boolean value_xmlgen_0
```
  - has_swingtree
```
protected boolean has_swingtree
```
  - value_swingtree_0
```
protected boolean value_swingtree_0
```
  - has_patterns
```
protected boolean has_patterns
```
  - value_patterns_0
```
protected boolean value_patterns_0
```
  - has_constructorsPre20181214
```
protected boolean has_constructorsPre20181214
```
  - value_constructorsPre20181214_0
```
protected boolean value_constructorsPre20181214_0
```
  - has_visitordebug
```
protected boolean has_visitordebug
```
  - value_visitordebug_0
```
protected boolean value_visitordebug_0
```
  - has_visitoroptimize
```
protected boolean has_visitoroptimize
```
  - value_visitoroptimize_0
```
protected boolean value_visitoroptimize_0
```
  - has_rewriterwarnings
```
protected boolean has_rewriterwarnings
```
  - value_rewriterwarnings_0
```
protected boolean value_rewriterwarnings_0
```
  - has_linewidth
```
protected boolean has_linewidth
```
  - value_linewidth_0
```
protected int value_linewidth_0
```
- Constructor Detail
  - Options
```
public Options()
```
- Method Detail
  - makeDefaultInstance
```
public Options makeDefaultInstance()
```
  - checkActive
```
protected void checkActive()
```
  - has_sourceroot
```
@Deprecated
public boolean has_sourceroot()
```
    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_sourceroot_0().
  - get_sourceroot_0
```
public String get_sourceroot_0()
```
    Getter method for the only argument of option sourceroot.
    This option indicates: file system directory which is the root of the source code hierarchie.
    
    The format of this option on the command line is
```
 
   -0 / --sourceroot     uri(="")
 
```
  - has_packagename
```
@Deprecated
public boolean has_packagename()
```
    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_packagename_0().
  - get_packagename_0
```
public String get_packagename_0()
```
    Getter method for the only argument of option packagename.
    This option indicates: name of the package of the generated model class.
    
    The format of this option on the command line is
```
 
   -1 / --packagename    string(="")
 
```
  - has_sourcefiles
```
@Deprecated
public boolean has_sourcefiles()
```
    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_sourcefiles().
  - get_sourcefiles
```
public List<Options.Values_sourcefiles> get_sourcefiles()
```
    Getter method for all repetition groups of option sourcefiles.
    This option indicates: source files containing the model declaration.
    
    The format of this option on the command line is
```
 
   -2 / --sourcefiles    ( uri(="") )+
 
```
  - get_sourcefiles_0
```
public String get_sourcefiles_0(int index)
```
    Getter method for the only repeated argument of option sourcefiles. For details of this option see the method get_sourcefiles().
    
    Parameters:
    
    index - the index of the repetition group, zero based.
  - has_monolithic
```
@Deprecated
public boolean has_monolithic()
```
    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_monolithic_0().
  - get_monolithic_0
```
public boolean get_monolithic_0()
```
    Getter method for the only argument of option monolithic.
    This option indicates: generate a single class instead of a package.
    
    The format of this option on the command line is
```
 
   -m / --monolithic     boolean(=true)
 
```
  - has_targetclasspath
```
@Deprecated
public boolean has_targetclasspath()
```
    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_targetclasspath().
  - get_targetclasspath
```
public List<Options.Values_targetclasspath> get_targetclasspath()
```
    Getter method for all repetition groups of option targetclasspath.
    This option indicates: classpath to search for existing class files, if different from current classpath. NOT YET ACTIVE!!.
    
    The format of this option on the command line is
```
 
   -p / --targetclasspath  ( uri(="") )*
 
```
  - get_targetclasspath_0
```
public String get_targetclasspath_0(int index)
```
    Getter method for the only repeated argument of option targetclasspath. For details of this option see the method get_targetclasspath().
    
    Parameters:
    
    index - the index of the repetition group, zero based.
  - has_floatNotDouble
```
@Deprecated
public boolean has_floatNotDouble()
```
    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_floatNotDouble_0().
  - get_floatNotDouble_0
```
public boolean get_floatNotDouble_0()
```
    Getter method for the only argument of option floatNotDouble.
    This option indicates: implement the umod type "float" not by doubles but by floats.
    
    The format of this option on the command line is
```
 
        --floatNotDouble  boolean(=false)
 
```
  - has_getterfunctions
```
@Deprecated
public boolean has_getterfunctions()
```
    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_getterfunctions_0().
  - get_getterfunctions_0
```
public boolean get_getterfunctions_0()
```
    Getter method for the only argument of option getterfunctions.
    This option indicates: whether to generate getter function objects DEPRECATED.
    
    The format of this option on the command line is
```
 
   -G / --getterfunctions  boolean(=false)
 
```
  - has_setterfunctions
```
@Deprecated
public boolean has_setterfunctions()
```
    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_setterfunctions_0().
  - get_setterfunctions_0
```
public boolean get_setterfunctions_0()
```
    Getter method for the only argument of option setterfunctions.
    This option indicates: whether to generate setter function objects DEPRECATED.
    
    The format of this option on the command line is
```
 
   -S / --setterfunctions  boolean(=false)
 
```
  - has_xmlgen
```
@Deprecated
public boolean has_xmlgen()
```
    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_xmlgen_0().
  - get_xmlgen_0
```
public boolean get_xmlgen_0()
```
    Getter method for the only argument of option xmlgen.
    This option indicates: whether to generate SAX de-/serialization.
    
    The format of this option on the command line is
```
 
   -x / --xmlgen         boolean(=true)
 
```
  - has_swingtree
```
@Deprecated
public boolean has_swingtree()
```
    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_swingtree_0().
  - get_swingtree_0
```
public boolean get_swingtree_0()
```
    Getter method for the only argument of option swingtree.
    This option indicates: whether to generate a swing tree visualization.
    
    The format of this option on the command line is
```
 
   -s / --swingtree      boolean(=false)
 
```
  - has_patterns
```
@Deprecated
public boolean has_patterns()
```
    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_patterns_0().
  - get_patterns_0
```
public boolean get_patterns_0()
```
    Getter method for the only argument of option patterns.
    This option indicates: Generate methods for lifting and applying "Paisley" patterns to model elements and their fields.
    
    The format of this option on the command line is
```
 
        --patterns       (bool)?(=true iff present)
 
```
  - has_constructorsPre20181214
```
@Deprecated
public boolean has_constructorsPre20181214()
```
    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_constructorsPre20181214_0().
  - get_constructorsPre20181214_0
```
public boolean get_constructorsPre20181214_0()
```
    Getter method for the 0th argument of option constructorsPre20181214.
    This option indicates: Use old constructor code generation scheme, prior to 20181214 redefinition.
    
    The format of this option on the command line is
```
 
        --constructorsPre20181214  (bool)?(=true iff present)
 
```
  - has_visitordebug
```
@Deprecated
public boolean has_visitordebug()
```
    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_visitordebug_0().
  - get_visitordebug_0
```
public boolean get_visitordebug_0()
```
    Getter method for the only argument of option visitordebug.
    This option indicates: whether to add logging code to the generated visitors.
    
    The format of this option on the command line is
```
 
   -V / --visitordebug   boolean(=false)
 
```
  - has_visitoroptimize
```
@Deprecated
public boolean has_visitoroptimize()
```
    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_visitoroptimize_0().
  - get_visitoroptimize_0
```
public boolean get_visitoroptimize_0()
```
    Getter method for the only argument of option visitoroptimize.
    This option indicates: whether to cut superfluous descends.
    
    The format of this option on the command line is
```
 
   -v / --visitoroptimize  boolean(=false)
 
```
  - has_rewriterwarnings
```
@Deprecated
public boolean has_rewriterwarnings()
```
    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_rewriterwarnings_0().
  - get_rewriterwarnings_0
```
public boolean get_rewriterwarnings_0()
```
    Getter method for the only argument of option rewriterwarnings.
    This option indicates: whether all warnings from rewriter code shall be printed, even when the code generation algorithm takes the responsibility.
    
    The format of this option on the command line is
```
 
        --rewriterwarnings  (bool)?(=true iff present)
 
```
  - has_linewidth
```
@Deprecated
public boolean has_linewidth()
```
    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_linewidth_0().
  - get_linewidth_0
```
public int get_linewidth_0()
```
    Getter method for the only argument of option linewidth.
    This option indicates: line width for the formatting of the generated source code.
    
    The format of this option on the command line is
```
 
   -w / --linewidth      int(=80)
 
```
  - serialize
```
public String serialize()
```
  - usage
```
public void usage(PrintStream pr)
```
    Print usage information in the default language.
  - 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.
  - 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)
```
  - parseName
```
protected void parseName(String select)
```
  - numberOfPositionals
```
protected int numberOfPositionals()
```
  - parsePositionals
```
protected void parsePositionals()
```
  - _finalCheck
```
protected void _finalCheck()
```
  - _getMissingOptions
```
public String _getMissingOptions()
```
  - _getRedundantOptions
```
public String _getRedundantOptions()
```

Class Options

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

has_sourceroot

value_sourceroot_0

has_packagename

value_packagename_0

has_sourcefiles

repvalues_sourcefiles

serialize_sourcefiles

has_monolithic

value_monolithic_0

has_targetclasspath

repvalues_targetclasspath

serialize_targetclasspath

has_floatNotDouble

value_floatNotDouble_0

has_getterfunctions

value_getterfunctions_0

has_setterfunctions

value_setterfunctions_0

has_xmlgen

value_xmlgen_0

has_swingtree

value_swingtree_0

has_patterns

value_patterns_0

has_constructorsPre20181214

value_constructorsPre20181214_0

has_visitordebug

value_visitordebug_0

has_visitoroptimize

value_visitoroptimize_0

has_rewriterwarnings

value_rewriterwarnings_0

has_linewidth

value_linewidth_0

Constructor Detail

Options

Method Detail

makeDefaultInstance

checkActive

has_sourceroot

get_sourceroot_0

has_packagename

get_packagename_0

has_sourcefiles

get_sourcefiles

get_sourcefiles_0

has_monolithic

get_monolithic_0

has_targetclasspath

get_targetclasspath

get_targetclasspath_0

has_floatNotDouble

get_floatNotDouble_0

has_getterfunctions

get_getterfunctions_0

has_setterfunctions

get_setterfunctions_0

has_xmlgen

get_xmlgen_0

has_swingtree

get_swingtree_0

has_patterns

get_patterns_0

has_constructorsPre20181214

get_constructorsPre20181214_0

has_visitordebug

get_visitordebug_0

has_visitoroptimize

get_visitoroptimize_0

has_rewriterwarnings

get_rewriterwarnings_0

has_linewidth

get_linewidth_0