Package eu.bandm.tools.util3
Class CallXsltOptions
Generated source for command line processing.
(A parallel GUI class has not been generated. The normal way of operation is:
(A parallel GUI class has not been generated. The normal way of operation is:
- Create a fresh instance by the only constructor
CallXsltOptions()
. - Analyse command line by invoking
Model.parse(String[],MessageReceiver,String)
- 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 byget_[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 (Model.getParsingProtocol()
, Model.getMissingOptions()
, Model.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 / --in string(="") input file -1 / --xsl string(="") transformtion code -2 / --out string(="") output file --xml (bool)?(=true iff present) use xml output formatter and output xml header --html (bool)?(=true iff present) use html output formatter --text (bool)?(=true iff present) use plain text output formatter --param ( string(="") string(="") )* pairs of parameter name and parameter value string --uriresolver string(="") full class name of uri resolver --entityresolver string(="") full class name of entity resolver --contenthandler string(="") full class name of content handler
Created on 2024-11-24_11h56m39
by program bandm/metatools/option/compiler, version 2.1
command line =
java bandm/metatools/option/compiler CallXsltOptions.xml eu.bandm.tools.util3 CallXsltOptions $(HOME)/metatools/src
by program bandm/metatools/option/compiler, version 2.1
command line =
java bandm/metatools/option/compiler CallXsltOptions.xml eu.bandm.tools.util3 CallXsltOptions $(HOME)/metatools/src
-
Nested Class Summary
Modifier and TypeClassDescriptionclass
Programmatically generated catalog of translations.class
One instance realizes one repeated argument group of optionparam
.Nested classes/interfaces inherited from class eu.bandm.tools.option.runtime.Model
Model.ExcDuplicate, Model.ExcEndOfRepet, Model.ExcNoData, Model.ExcNoData_allowed, Model.ExcSkipReachesEnd, Model.ExcUnknownOpt, Model.ExcWrongType, Model.Pre20220613, Model.SeemsToWorkForLinuxAndSomeWindowsVersions20220613
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected List<CallXsltOptions.Values_param>
protected String
protected String
protected boolean
protected String
protected String
protected boolean
protected String
protected boolean
protected String
Fields inherited from class eu.bandm.tools.option.runtime.Model
curArg, curArgGroup, curOption, currentErrorPos, descriptions, dummyRat, GNU_VERSION_OPTION, hasNonMetaOptions, inputlength, inputstring, matcher, messages, msg, nextToken, optionDirector, p_rest, positionalPhase, positionalsExplicit, positionalsFound, protocol, shellAdapter
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
Callback, overridden by compiled code.Is overridden in the generated code and concatenates the "longest names" of all otions marked as required, but not present in the parsed input.Callback, overridden by compiled code.protected void
The generated code will evaluate all conditions to activate/deactive options in the GUI.Getter method for the only argument of optioncontenthandler
.Getter method for the only argument of optionentityresolver
.boolean
Getter method for the 0th argument of optionhtml
.get_in_0()
Getter method for the only argument of optionin
.Getter method for the only argument of optionout
.Getter method for all repetition groups of optionparam
.get_param_0
(int index) Getter method for the 0th in a group of repeated arguments of optionparam
.get_param_1
(int index) Getter method for the 1st in a group of repeated arguments of optionparam
.boolean
Getter method for the 0th argument of optiontext
.Getter method for the only argument of optionuriresolver
.boolean
Getter method for the only argument of optionxml
.Getter method for the only argument of optionxsl
.boolean
Deprecated.boolean
Deprecated.boolean
has_html()
Deprecated.boolean
has_in()
Deprecated.boolean
has_out()
Deprecated.boolean
Deprecated.boolean
has_text()
Deprecated.boolean
Deprecated.boolean
has_xml()
Deprecated.boolean
has_xsl()
Deprecated.Overriden by the generated code to make a constructor call of the actual Model (sub-)class.protected int
The generated code will return the number of positional parameters.protected void
parseAbbrev
(String select) Callback, overridden by compiled code, which realizes a switch over all one character option names.protected void
Callback, overridden by compiled code, which realizes a switch over all long option names.protected void
Callback, overridden by compiled code, which calls one after the other the positional parameters.Called to generate a String representation of the model's state.void
usage
(PrintStream pr) Print usage information in the default language.void
usage
(PrintStream pr, String lang) Print usage information in the requested language.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'.Methods inherited from class eu.bandm.tools.option.runtime.Model
ARG_ERROR, ARG_ERROR, canReenterRepetitionGroup, convert_integer_10_or_16, descriptionKeyForCommentField, descriptionKeyForEnum, descriptionKeyForEnum, descriptionKeyForEnumItem, ERROR, ERROR_plus, ERROR_UNKNOWN_ABBREV, ERROR_UNKNOWN_NAME, getInputString, getMissingOptions, getNextToken, getNextToken_required, getParsingProtocol, HINT, input_as_its_own_id, INSITU, parse, parseBool, parseBool_optional, parseBoolTest, parseEnum, parseEnumSet, parseFloat, parseInit, parseInt, parseInt_16or10, parseOneString, parseOneString, parseOneString, parseOneUri, parseRational, parseString, putprot, putprot_option, serialize, serialize, serialize, serialize, serialize, serialize, serialize, serialize, serialize_hex, skipToOption, type_error, TYPE_MISMATCH, TYPE_MISMATCH, usage, usage, WARNING
-
Field Details
-
has_in
protected boolean has_in -
value_in_0
-
has_xsl
protected boolean has_xsl -
value_xsl_0
-
has_out
protected boolean has_out -
value_out_0
-
has_xml
protected boolean has_xml -
value_xml_0
protected boolean value_xml_0 -
has_html
protected boolean has_html -
value_html_0
protected boolean value_html_0 -
has_text
protected boolean has_text -
value_text_0
protected boolean value_text_0 -
has_param
protected boolean has_param -
repvalues_param
-
serialize_param
-
has_uriresolver
protected boolean has_uriresolver -
value_uriresolver_0
-
has_entityresolver
protected boolean has_entityresolver -
value_entityresolver_0
-
has_contenthandler
protected boolean has_contenthandler -
value_contenthandler_0
-
-
Constructor Details
-
CallXsltOptions
public CallXsltOptions()
-
-
Method Details
-
makeDefaultInstance
Description copied from class:Model
Overriden by the generated code to make a constructor call of the actual Model (sub-)class.- Specified by:
makeDefaultInstance
in classModel<CallXsltOptions>
-
checkActive
protected void checkActive()Description copied from class:Model
The generated code will evaluate all conditions to activate/deactive options in the GUI.- Specified by:
checkActive
in classModel<CallXsltOptions>
-
has_in
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_in_0()
.
-
get_in_0
Getter method for the only argument of optionin
.This option indicates: input file.
The format of this option on the command line is-0 / --in string(="")
-
has_xsl
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_xsl_0()
.
-
get_xsl_0
Getter method for the only argument of optionxsl
.This option indicates: transformtion code.
The format of this option on the command line is-1 / --xsl string(="")
-
has_out
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_out_0()
.
-
get_out_0
Getter method for the only argument of optionout
.This option indicates: output file.
The format of this option on the command line is-2 / --out string(="")
-
has_xml
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_xml_0()
.
-
get_xml_0
public boolean get_xml_0()Getter method for the only argument of optionxml
.This option indicates: use xml output formatter and output xml header.
The format of this option on the command line is--xml (bool)?(=true iff present)
-
has_html
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_html_0()
.
-
get_html_0
public boolean get_html_0()Getter method for the 0th argument of optionhtml
.This option indicates: use html output formatter.
The format of this option on the command line is--html (bool)?(=true iff present)
-
has_text
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_text_0()
.
-
get_text_0
public boolean get_text_0()Getter method for the 0th argument of optiontext
.This option indicates: use plain text output formatter.
The format of this option on the command line is--text (bool)?(=true iff present)
-
has_param
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_param()
.
-
get_param
Getter method for all repetition groups of optionparam
.This option indicates: pairs of parameter name and parameter value string.
The format of this option on the command line is--param ( string(="") string(="") )*
-
get_param_0
Getter method for the 0th in a group of repeated arguments of optionparam
. For details of this option see the methodget_param()
.- Parameters:
index
- the index of the repetition group, zero based.
-
get_param_1
Getter method for the 1st in a group of repeated arguments of optionparam
. For details of this option see the methodget_param()
.- Parameters:
index
- the index of the repetition group, zero based.
-
has_uriresolver
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_uriresolver_0()
.
-
get_uriresolver_0
Getter method for the only argument of optionuriresolver
.This option indicates: full class name of uri resolver.
The format of this option on the command line is--uriresolver string(="")
-
has_entityresolver
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_entityresolver_0()
.
-
get_entityresolver_0
Getter method for the only argument of optionentityresolver
.This option indicates: full class name of entity resolver.
The format of this option on the command line is--entityresolver string(="")
-
has_contenthandler
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_contenthandler_0()
.
-
get_contenthandler_0
Getter method for the only argument of optioncontenthandler
.This option indicates: full class name of content handler.
The format of this option on the command line is--contenthandler string(="")
-
serialize
Description copied from class:Model
Called to generate a String representation of the model's state. Code is overridden by the compiled code.- Specified by:
serialize
in classModel<CallXsltOptions>
-
usage
Print usage information in the default language.- Specified by:
usage
in classModel<CallXsltOptions>
-
usage
Print usage information in the requested language. Falls back to default language, if that language is not supported.- Specified by:
usage
in classModel<CallXsltOptions>
-
usage_en
public void usage_en()Print usage information in the language 'en' on System.err. -
usage_en
Print usage information in the language 'en'. -
parseAbbrev
Description copied from class:Model
Callback, overridden by compiled code, which realizes a switch over all one character option names. The generated code calls the argument parsers and stores the resulting values to the model's fields.- Specified by:
parseAbbrev
in classModel<CallXsltOptions>
- Parameters:
select
- the one-character option name, as parsed by this code.
-
parseName
Description copied from class:Model
Callback, overridden by compiled code, which realizes a switch over all long option names. The generated code calls the argument parsers and stores the resulting values to the model's fields.- Specified by:
parseName
in classModel<CallXsltOptions>
- Parameters:
select
- the multi-character option name, as parsed by this code.
-
numberOfPositionals
protected int numberOfPositionals()Description copied from class:Model
The generated code will return the number of positional parameters.- Specified by:
numberOfPositionals
in classModel<CallXsltOptions>
-
parsePositionals
protected void parsePositionals()Description copied from class:Model
Callback, overridden by compiled code, which calls one after the other the positional parameters. Each of them corresponds to an implicit option (with short names "-0 ", "-1 ", "-2 ", ...). These can also be defined explicitly, e.g. be given a long name, etc. Anyhow, they can be set explicitly by their short name. If one single positional option is given explicitly, the implicit parsing of the others is suppressed and this code will not be called.- Specified by:
parsePositionals
in classModel<CallXsltOptions>
-
_finalCheck
protected void _finalCheck()Description copied from class:Model
Callback, overridden by compiled code.- Specified by:
_finalCheck
in classModel<CallXsltOptions>
-
_getMissingOptions
Description copied from class:Model
Is overridden in the generated code and concatenates the "longest names" of all otions marked as required, but not present in the parsed input. Length==0 iff none is missing. Cf "sourcedtd required='yes'" in tools/tdom_withOptions/Options.xml- Specified by:
_getMissingOptions
in classModel<CallXsltOptions>
-
_getRedundantOptions
Description copied from class:Model
Callback, overridden by compiled code.- Specified by:
_getRedundantOptions
in classModel<CallXsltOptions>
-