JarLinkerOptions (BandM metatools API doc)

java.lang.Object
- <any>
- - eu.bandm.tools.util3.JarLinkerOptions

```
public class JarLinkerOptions
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 JarLinkerOptions().
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:
 ======
 --main           ( string(="") )+
 the name(s) of the main class(es) which define reachability. The very first 
    will be the *main*  class in the jars Manifest. 
 --exclude        ( string(="") )+
 names of packages to exclude. 
 --inputs         ( uri(="") )+
 the binary input sources in which to search (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 
 --manifest       uri(="")
 base manifest file
 --seal           boolean(=false)
 whether to seal all packages
 
 
```
Created on 2022-06-30_15h10m33
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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`JarLinkerOptions.Descriptions` Programmatically generated catalog of translations.
`class`	`JarLinkerOptions.Values_exclude` One instance realizes one repeated argument group of option `exclude`.
`class`	`JarLinkerOptions.Values_inputs` One instance realizes one repeated argument group of option `inputs`.
`class`	`JarLinkerOptions.Values_main` One instance realizes one repeated argument group of option `main`.
`class`	`JarLinkerOptions.Values_ressourceDirs` One instance realizes one repeated argument group of option `ressourceDirs`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`has_debug`
`protected boolean`	`has_exclude`
`protected boolean`	`has_inputs`
`protected boolean`	`has_main`
`protected boolean`	`has_manifest`
`protected boolean`	`has_output`
`protected boolean`	`has_ressourceDirs`
`protected boolean`	`has_seal`
`protected List<JarLinkerOptions.Values_exclude>`	`repvalues_exclude`
`protected List<JarLinkerOptions.Values_inputs>`	`repvalues_inputs`
`protected List<JarLinkerOptions.Values_main>`	`repvalues_main`
`protected List<JarLinkerOptions.Values_ressourceDirs>`	`repvalues_ressourceDirs`
`Function<JarLinkerOptions.Values_exclude,String>`	`serialize_exclude`
`Function<JarLinkerOptions.Values_inputs,String>`	`serialize_inputs`
`Function<JarLinkerOptions.Values_main,String>`	`serialize_main`
`Function<JarLinkerOptions.Values_ressourceDirs,String>`	`serialize_ressourceDirs`
`protected int`	`value_debug_0`
`protected String`	`value_manifest_0`
`protected String`	`value_output_0`
`protected boolean`	`value_seal_0`

Constructor Summary

Constructors
Constructor and Description

JarLinkerOptions()

Constructors
Constructor and Description
`JarLinkerOptions()`

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()`
`int`	`get_debug_0()` Getter method for the only argument of option `debug`.
`String`	`get_exclude_0(int index)` Getter method for the only repeated argument of option `exclude`.
`List<JarLinkerOptions.Values_exclude>`	`get_exclude()` Getter method for all repetition groups of option `exclude`.
`String`	`get_inputs_0(int index)` Getter method for the only repeated argument of option `inputs`.
`List<JarLinkerOptions.Values_inputs>`	`get_inputs()` Getter method for all repetition groups of option `inputs`.
`String`	`get_main_0(int index)` Getter method for the only repeated argument of option `main`.
`List<JarLinkerOptions.Values_main>`	`get_main()` Getter method for all repetition groups of option `main`.
`String`	`get_manifest_0()` Getter method for the only argument of option `manifest`.
`String`	`get_output_0()` Getter method for the only argument of option `output`.
`String`	`get_ressourceDirs_0(int index)` Getter method for the 0th in a group of repeated arguments of option `ressourceDirs`.
`String`	`get_ressourceDirs_1(int index)` Getter method for the 1st in a group of repeated arguments of option `ressourceDirs`.
`List<JarLinkerOptions.Values_ressourceDirs>`	`get_ressourceDirs()` Getter method for all repetition groups of option `ressourceDirs`.
`boolean`	`get_seal_0()` Getter method for the only argument of option `seal`.
`boolean`	`has_debug()` Deprecated.
`boolean`	`has_exclude()` Deprecated.
`boolean`	`has_inputs()` Deprecated.
`boolean`	`has_main()` Deprecated.
`boolean`	`has_manifest()` Deprecated.
`boolean`	`has_output()` Deprecated.
`boolean`	`has_ressourceDirs()` Deprecated.
`boolean`	`has_seal()` Deprecated.
`JarLinkerOptions`	`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_main
```
protected boolean has_main
```
  - repvalues_main
```
protected List<JarLinkerOptions.Values_main> repvalues_main
```
  - serialize_main
```
public final Function<JarLinkerOptions.Values_main,String> serialize_main
```
  - has_exclude
```
protected boolean has_exclude
```
  - repvalues_exclude
```
protected List<JarLinkerOptions.Values_exclude> repvalues_exclude
```
  - serialize_exclude
```
public final Function<JarLinkerOptions.Values_exclude,String> serialize_exclude
```
  - has_inputs
```
protected boolean has_inputs
```
  - repvalues_inputs
```
protected List<JarLinkerOptions.Values_inputs> repvalues_inputs
```
  - serialize_inputs
```
public final Function<JarLinkerOptions.Values_inputs,String> serialize_inputs
```
  - has_output
```
protected boolean has_output
```
  - value_output_0
```
protected String value_output_0
```
  - has_debug
```
protected boolean has_debug
```
  - value_debug_0
```
protected int value_debug_0
```
  - has_ressourceDirs
```
protected boolean has_ressourceDirs
```
  - repvalues_ressourceDirs
```
protected List<JarLinkerOptions.Values_ressourceDirs> repvalues_ressourceDirs
```
  - serialize_ressourceDirs
```
public final Function<JarLinkerOptions.Values_ressourceDirs,String> serialize_ressourceDirs
```
  - has_manifest
```
protected boolean has_manifest
```
  - value_manifest_0
```
protected String value_manifest_0
```
  - has_seal
```
protected boolean has_seal
```
  - value_seal_0
```
protected boolean value_seal_0
```
- Constructor Detail
  - JarLinkerOptions
```
public JarLinkerOptions()
```
- Method Detail
  - makeDefaultInstance
```
public JarLinkerOptions makeDefaultInstance()
```
  - checkActive
```
protected void checkActive()
```
  - 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 jars 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 to exclude.
    
    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 (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 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()
```
  - 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 JarLinkerOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

has_main

repvalues_main

serialize_main

has_exclude

repvalues_exclude

serialize_exclude

has_inputs

repvalues_inputs

serialize_inputs

has_output

value_output_0

has_debug

value_debug_0

has_ressourceDirs

repvalues_ressourceDirs

serialize_ressourceDirs

has_manifest

value_manifest_0

has_seal

value_seal_0

Constructor Detail

JarLinkerOptions

Method Detail

makeDefaultInstance

checkActive

has_main

get_main

get_main_0

has_exclude

get_exclude

get_exclude_0

has_inputs

get_inputs

get_inputs_0

has_output

get_output_0

has_debug

get_debug_0

has_ressourceDirs

get_ressourceDirs

get_ressourceDirs_0

get_ressourceDirs_1

has_manifest

get_manifest_0

has_seal

get_seal_0

serialize

usage

usage

usage_en

usage_en

parseAbbrev

parseName

numberOfPositionals

parsePositionals

_finalCheck

_getMissingOptions

_getRedundantOptions