Options (BandM metatools API doc)

java.lang.Object
- <any>
- - eu.bandm.tools.lljava.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:
 ======
 -d / --destination    uri(=".")
 file system directory which is the root of the class file hierarchy
 -0 / --sourcefile     ( uri(="") )*
 source file containing the model declaration
 -V / --version        (bool)?(=true iff present)
 give version information
 
 
```
Created on 2022-06-30_15h12m47
by program bandm/metatools/option/compiler, version 2.1
command line =
bandm/metatools/option/compiler options.xml eu.bandm.tools.lljava Options $(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_sourcefile` One instance realizes one repeated argument group of option `sourcefile`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`has_destination`
`protected boolean`	`has_sourcefile`
`protected boolean`	`has_version`
`protected List<Options.Values_sourcefile>`	`repvalues_sourcefile`
`Function<Options.Values_sourcefile,String>`	`serialize_sourcefile`
`protected String`	`value_destination_0`
`protected boolean`	`value_version_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_destination_0()` Getter method for the only argument of option `destination`.
`String`	`get_sourcefile_0(int index)` Getter method for the only repeated argument of option `sourcefile`.
`List<Options.Values_sourcefile>`	`get_sourcefile()` Getter method for all repetition groups of option `sourcefile`.
`boolean`	`get_version_0()` Getter method for the only argument of option `version`.
`boolean`	`has_destination()` Deprecated.
`boolean`	`has_sourcefile()` Deprecated.
`boolean`	`has_version()` 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_destination
```
protected boolean has_destination
```
  - value_destination_0
```
protected String value_destination_0
```
  - has_sourcefile
```
protected boolean has_sourcefile
```
  - repvalues_sourcefile
```
protected List<Options.Values_sourcefile> repvalues_sourcefile
```
  - serialize_sourcefile
```
public final Function<Options.Values_sourcefile,String> serialize_sourcefile
```
  - has_version
```
protected boolean has_version
```
  - value_version_0
```
protected boolean value_version_0
```
- Constructor Detail
  - Options
```
public Options()
```
- Method Detail
  - makeDefaultInstance
```
public Options makeDefaultInstance()
```
  - checkActive
```
protected void checkActive()
```
  - has_destination
```
@Deprecated
public boolean has_destination()
```
    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_destination_0().
  - get_destination_0
```
public String get_destination_0()
```
    Getter method for the only argument of option destination.
    This option indicates: file system directory which is the root of the class file hierarchy.
    
    The format of this option on the command line is
```
 
   -d / --destination    uri(=".")
 
```
  - has_sourcefile
```
@Deprecated
public boolean has_sourcefile()
```
    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_sourcefile().
  - get_sourcefile
```
public List<Options.Values_sourcefile> get_sourcefile()
```
    Getter method for all repetition groups of option sourcefile.
    This option indicates: source file containing the model declaration.
    
    The format of this option on the command line is
```
 
   -0 / --sourcefile     ( uri(="") )*
 
```
  - get_sourcefile_0
```
public String get_sourcefile_0(int index)
```
    Getter method for the only repeated argument of option sourcefile. For details of this option see the method get_sourcefile().
    
    Parameters:
    
    index - the index of the repetition group, zero based.
  - has_version
```
@Deprecated
public boolean has_version()
```
    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_version_0().
  - get_version_0
```
public boolean get_version_0()
```
    Getter method for the only argument of option version.
    This option indicates: give version information.
    
    The format of this option on the command line is
```
 
   -V / --version        (bool)?(=true iff present)
 
```
  - 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_destination

value_destination_0

has_sourcefile

repvalues_sourcefile

serialize_sourcefile

has_version

value_version_0

Constructor Detail

Options

Method Detail

makeDefaultInstance

checkActive

has_destination

get_destination_0

has_sourcefile

get_sourcefile

get_sourcefile_0

has_version

get_version_0

serialize

usage

usage

usage_en

usage_en

parseAbbrev

parseName

numberOfPositionals

parsePositionals

_finalCheck

_getMissingOptions

_getRedundantOptions