JWhichOptions (BandM metatools API doc)

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

```
public class JWhichOptions
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 JWhichOptions().
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:
 ======
 --classpath      string(="")
    classpath
 --package        string(="")
 package name
 -0 / --target         ( string(="") )+
 target class name
 --sourcefile     string(="")
 source file name
 -v / --verbose        boolean(=false)
 log activity to stderr
 -i / --anyinnerclasses  boolean(=false)
 search unqualified inner classes anywhere
 
 
```
Created on 2022-06-30_15h10m35
by program bandm/metatools/option/compiler, version 2.1
command line =
bandm/metatools/option/compiler JWhichOptions.xml eu.bandm.tools.util3 JWhichOptions $(HOME)/metatools/src

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`JWhichOptions.Descriptions` Programmatically generated catalog of translations.
`class`	`JWhichOptions.Values_target` One instance realizes one repeated argument group of option `target`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`has_anyinnerclasses`
`protected boolean`	`has_classpath`
`protected boolean`	`has_package`
`protected boolean`	`has_sourcefile`
`protected boolean`	`has_target`
`protected boolean`	`has_verbose`
`protected List<JWhichOptions.Values_target>`	`repvalues_target`
`Function<JWhichOptions.Values_target,String>`	`serialize_target`
`protected boolean`	`value_anyinnerclasses_0`
`protected String`	`value_classpath_0`
`protected String`	`value_package_0`
`protected String`	`value_sourcefile_0`
`protected boolean`	`value_verbose_0`

Constructor Summary

Constructors
Constructor and Description

JWhichOptions()

Constructors
Constructor and Description
`JWhichOptions()`

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_anyinnerclasses_0()` Getter method for the only argument of option `anyinnerclasses`.
`String`	`get_classpath_0()` Getter method for the only argument of option `classpath`.
`String`	`get_package_0()` Getter method for the only argument of option `package`.
`String`	`get_sourcefile_0()` Getter method for the only argument of option `sourcefile`.
`String`	`get_target_0(int index)` Getter method for the only repeated argument of option `target`.
`List<JWhichOptions.Values_target>`	`get_target()` Getter method for all repetition groups of option `target`.
`boolean`	`get_verbose_0()` Getter method for the only argument of option `verbose`.
`boolean`	`has_anyinnerclasses()` Deprecated.
`boolean`	`has_classpath()` Deprecated.
`boolean`	`has_package()` Deprecated.
`boolean`	`has_sourcefile()` Deprecated.
`boolean`	`has_target()` Deprecated.
`boolean`	`has_verbose()` Deprecated.
`JWhichOptions`	`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_classpath
```
protected boolean has_classpath
```
  - value_classpath_0
```
protected String value_classpath_0
```
  - has_package
```
protected boolean has_package
```
  - value_package_0
```
protected String value_package_0
```
  - has_target
```
protected boolean has_target
```
  - repvalues_target
```
protected List<JWhichOptions.Values_target> repvalues_target
```
  - serialize_target
```
public final Function<JWhichOptions.Values_target,String> serialize_target
```
  - has_sourcefile
```
protected boolean has_sourcefile
```
  - value_sourcefile_0
```
protected String value_sourcefile_0
```
  - has_verbose
```
protected boolean has_verbose
```
  - value_verbose_0
```
protected boolean value_verbose_0
```
  - has_anyinnerclasses
```
protected boolean has_anyinnerclasses
```
  - value_anyinnerclasses_0
```
protected boolean value_anyinnerclasses_0
```
- Constructor Detail
  - JWhichOptions
```
public JWhichOptions()
```
- Method Detail
  - makeDefaultInstance
```
public JWhichOptions makeDefaultInstance()
```
  - checkActive
```
protected void checkActive()
```
  - has_classpath
```
@Deprecated
public boolean has_classpath()
```
    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_classpath_0().
  - get_classpath_0
```
public String get_classpath_0()
```
    Getter method for the only argument of option classpath.
    This option indicates: classpath.
    
    The format of this option on the command line is
```
 
        --classpath      string(="")
 
```
  - has_package
```
@Deprecated
public boolean has_package()
```
    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_package_0().
  - get_package_0
```
public String get_package_0()
```
    Getter method for the only argument of option package.
    This option indicates: package name.
    
    The format of this option on the command line is
```
 
        --package        string(="")
 
```
  - has_target
```
@Deprecated
public boolean has_target()
```
    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_target().
  - get_target
```
public List<JWhichOptions.Values_target> get_target()
```
    Getter method for all repetition groups of option target.
    This option indicates: target class name.
    
    The format of this option on the command line is
```
 
   -0 / --target         ( string(="") )+
 
```
  - get_target_0
```
public String get_target_0(int index)
```
    Getter method for the only repeated argument of option target. For details of this option see the method get_target().
    
    Parameters:
    
    index - the index of the repetition group, zero based.
  - 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_0().
  - get_sourcefile_0
```
public String get_sourcefile_0()
```
    Getter method for the only argument of option sourcefile.
    This option indicates: source file name.
    
    The format of this option on the command line is
```
 
        --sourcefile     string(="")
 
```
  - has_verbose
```
@Deprecated
public boolean has_verbose()
```
    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_verbose_0().
  - get_verbose_0
```
public boolean get_verbose_0()
```
    Getter method for the only argument of option verbose.
    This option indicates: log activity to stderr.
    
    The format of this option on the command line is
```
 
   -v / --verbose        boolean(=false)
 
```
  - has_anyinnerclasses
```
@Deprecated
public boolean has_anyinnerclasses()
```
    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_anyinnerclasses_0().
  - get_anyinnerclasses_0
```
public boolean get_anyinnerclasses_0()
```
    Getter method for the only argument of option anyinnerclasses.
    This option indicates: search unqualified inner classes anywhere.
    
    The format of this option on the command line is
```
 
   -i / --anyinnerclasses  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 JWhichOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

has_classpath

value_classpath_0

has_package

value_package_0

has_target

repvalues_target

serialize_target

has_sourcefile

value_sourcefile_0

has_verbose

value_verbose_0

has_anyinnerclasses

value_anyinnerclasses_0

Constructor Detail

JWhichOptions

Method Detail

makeDefaultInstance

checkActive

has_classpath

get_classpath_0

has_package

get_package_0

has_target

get_target

get_target_0

has_sourcefile

get_sourcefile_0

has_verbose

get_verbose_0

has_anyinnerclasses

get_anyinnerclasses_0

serialize

usage

usage

usage_en

usage_en

parseAbbrev

parseName

numberOfPositionals

parsePositionals

_finalCheck

_getMissingOptions

_getRedundantOptions