Options (BandM metatools API doc)

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

```
public class Options
extends <any>
```
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 Options().
2. Analyse command line by invoking #parse(String[],MessageReceiver)
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 (#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:
 ======
 -0 / --destdir        string(="")
 file system mounting point of the generated source tree
 -1 / --pkgname        string(="")
 name of the generated package. Determines the position of generated resources
    relative to destdir
 -2 / --sourcedtd      string(="")
 file position of dtd to compile
 --linewidth      int(=78)
 number of columns for the generated Java source text. This is NOT a strict 
    limit, but a strong orientation.
 --patterns       (bool)?(=true iff present)
 whether "paisley"  pattern access methods shall be generated.
 --noCompress     (bool)?(=true iff present)
 whether the decode/encode methods shall be omitted
 --commonContentClass  (bool)?(=true iff present)
 whether to generate only one common subclass of MixedContent for PCData only 
    elements per model
 -C / --baseClass      string(="eu.bandm.tools.tdom.runtime.TypedElement")
 base class for all generated element classes 
 --generateLists  boolean(=false)
 generate checked list classes for repeated sub-contents, not arrays 
 
 
```
Created on 2022-06-30_15h11m04
by program bandm/metatools/option/compiler, version 2.1
command line =
bandm/metatools/option/compiler Options.xml eu.bandm.tools.tdom Options $(HOME)/metatools/src

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Options.Descriptions
Programmatically generated catalog of translations.

Nested Classes
Modifier and Type	Class and Description
`class`	`Options.Descriptions` Programmatically generated catalog of translations.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`has_baseClass`
`protected boolean`	`has_commonContentClass`
`protected boolean`	`has_destdir`
`protected boolean`	`has_generateLists`
`protected boolean`	`has_linewidth`
`protected boolean`	`has_noCompress`
`protected boolean`	`has_patterns`
`protected boolean`	`has_pkgname`
`protected boolean`	`has_sourcedtd`
`protected String`	`value_baseClass_0`
`protected boolean`	`value_commonContentClass_0`
`protected String`	`value_destdir_0`
`protected boolean`	`value_generateLists_0`
`protected int`	`value_linewidth_0`
`protected boolean`	`value_noCompress_0`
`protected boolean`	`value_patterns_0`
`protected String`	`value_pkgname_0`
`protected String`	`value_sourcedtd_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()`
`String`	`get_baseClass_0()` Getter method for the only argument of option `baseClass`.
`boolean`	`get_commonContentClass_0()` Getter method for the 0th argument of option `commonContentClass`.
`String`	`get_destdir_0()` Getter method for the only argument of option `destdir`.
`boolean`	`get_generateLists_0()` Getter method for the only argument of option `generateLists`.
`int`	`get_linewidth_0()` Getter method for the only argument of option `linewidth`.
`boolean`	`get_noCompress_0()` Getter method for the 0th argument of option `noCompress`.
`boolean`	`get_patterns_0()` Getter method for the only argument of option `patterns`.
`String`	`get_pkgname_0()` Getter method for the only argument of option `pkgname`.
`String`	`get_sourcedtd_0()` Getter method for the only argument of option `sourcedtd`.
`boolean`	`has_baseClass()` Deprecated.
`boolean`	`has_commonContentClass()` Deprecated.
`boolean`	`has_destdir()` Deprecated.
`boolean`	`has_generateLists()` Deprecated.
`boolean`	`has_linewidth()` Deprecated.
`boolean`	`has_noCompress()` Deprecated.
`boolean`	`has_patterns()` Deprecated.
`boolean`	`has_pkgname()` Deprecated.
`boolean`	`has_sourcedtd()` 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_destdir
```
protected boolean has_destdir
```
  - value_destdir_0
```
protected String value_destdir_0
```
  - has_pkgname
```
protected boolean has_pkgname
```
  - value_pkgname_0
```
protected String value_pkgname_0
```
  - has_sourcedtd
```
protected boolean has_sourcedtd
```
  - value_sourcedtd_0
```
protected String value_sourcedtd_0
```
  - has_linewidth
```
protected boolean has_linewidth
```
  - value_linewidth_0
```
protected int value_linewidth_0
```
  - has_patterns
```
protected boolean has_patterns
```
  - value_patterns_0
```
protected boolean value_patterns_0
```
  - has_noCompress
```
protected boolean has_noCompress
```
  - value_noCompress_0
```
protected boolean value_noCompress_0
```
  - has_commonContentClass
```
protected boolean has_commonContentClass
```
  - value_commonContentClass_0
```
protected boolean value_commonContentClass_0
```
  - has_baseClass
```
protected boolean has_baseClass
```
  - value_baseClass_0
```
protected String value_baseClass_0
```
  - has_generateLists
```
protected boolean has_generateLists
```
  - value_generateLists_0
```
protected boolean value_generateLists_0
```
- Constructor Detail
  - Options
```
public Options()
```
- Method Detail
  - makeDefaultInstance
```
public Options makeDefaultInstance()
```
  - checkActive
```
protected void checkActive()
```
  - has_destdir
```
@Deprecated
public boolean has_destdir()
```
    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_destdir_0().
  - get_destdir_0
```
public String get_destdir_0()
```
    Getter method for the only argument of option destdir.
    This option indicates: file system mounting point of the generated source tree.
    
    The format of this option on the command line is
```
 
   -0 / --destdir        string(="")
 
```
  - has_pkgname
```
@Deprecated
public boolean has_pkgname()
```
    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_pkgname_0().
  - get_pkgname_0
```
public String get_pkgname_0()
```
    Getter method for the only argument of option pkgname.
    This option indicates: name of the generated package. Determines the position of generated resources relative to destdir.
    
    The format of this option on the command line is
```
 
   -1 / --pkgname        string(="")
 
```
  - has_sourcedtd
```
@Deprecated
public boolean has_sourcedtd()
```
    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_sourcedtd_0().
  - get_sourcedtd_0
```
public String get_sourcedtd_0()
```
    Getter method for the only argument of option sourcedtd.
    This option indicates: file position of dtd to compile.
    
    The format of this option on the command line is
```
 
   -2 / --sourcedtd      string(="")
 
```
  - 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: number of columns for the generated Java source text. This is NOT a strict limit, but a strong orientation.
    
    The format of this option on the command line is
```
 
        --linewidth      int(=78)
 
```
  - 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: whether "paisley" pattern access methods shall be generated.
    
    The format of this option on the command line is
```
 
        --patterns       (bool)?(=true iff present)
 
```
  - has_noCompress
```
@Deprecated
public boolean has_noCompress()
```
    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_noCompress_0().
  - get_noCompress_0
```
public boolean get_noCompress_0()
```
    Getter method for the 0th argument of option noCompress.
    This option indicates: whether the decode/encode methods shall be omitted.
    
    The format of this option on the command line is
```
 
        --noCompress     (bool)?(=true iff present)
 
```
  - has_commonContentClass
```
@Deprecated
public boolean has_commonContentClass()
```
    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_commonContentClass_0().
  - get_commonContentClass_0
```
public boolean get_commonContentClass_0()
```
    Getter method for the 0th argument of option commonContentClass.
    This option indicates: whether to generate only one common subclass of MixedContent for PCData only elements per model.
    
    The format of this option on the command line is
```
 
        --commonContentClass  (bool)?(=true iff present)
 
```
  - has_baseClass
```
@Deprecated
public boolean has_baseClass()
```
    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_baseClass_0().
  - get_baseClass_0
```
public String get_baseClass_0()
```
    Getter method for the only argument of option baseClass.
    This option indicates: base class for all generated element classes.
    
    The format of this option on the command line is
```
 
   -C / --baseClass      string(="eu.bandm.tools.tdom.runtime.TypedElement")
 
```
  - has_generateLists
```
@Deprecated
public boolean has_generateLists()
```
    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_generateLists_0().
  - get_generateLists_0
```
public boolean get_generateLists_0()
```
    Getter method for the only argument of option generateLists.
    This option indicates: generate checked list classes for repeated sub-contents, not arrays.
    
    The format of this option on the command line is
```
 
        --generateLists  boolean(=false)
 
```
  - 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_destdir

value_destdir_0

has_pkgname

value_pkgname_0

has_sourcedtd

value_sourcedtd_0

has_linewidth

value_linewidth_0

has_patterns

value_patterns_0

has_noCompress

value_noCompress_0

has_commonContentClass

value_commonContentClass_0

has_baseClass

value_baseClass_0

has_generateLists

value_generateLists_0

Constructor Detail

Options

Method Detail

makeDefaultInstance

checkActive

has_destdir

get_destdir_0

has_pkgname

get_pkgname_0

has_sourcedtd

get_sourcedtd_0

has_linewidth

get_linewidth_0

has_patterns

get_patterns_0

has_noCompress

get_noCompress_0

has_commonContentClass

get_commonContentClass_0

has_baseClass

get_baseClass_0

has_generateLists

get_generateLists_0

serialize

usage

usage

usage_en

usage_en

parseAbbrev

parseName

numberOfPositionals

parsePositionals

_finalCheck

_getMissingOptions

_getRedundantOptions