Package eu.bandm.tools.doctypes.ps
Class InsertOverprintOptions
java.lang.Object
eu.bandm.tools.option.runtime.Model<InsertOverprintOptions>
eu.bandm.tools.doctypes.ps.InsertOverprintOptions
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
InsertOverprintOptions()
. - 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 / --inputfile uri(="") input file -1 / --outputfile uri(="") output file -t / --text ( string(="") )+ text to overprint on each page -a / --angle int(=65) angle of overprinted text -g / --grayvalue float(=0.9) grey value used for overprinted text
Created on 2024-03-03_16h28m08
by program bandm/metatools/option/compiler, version 2.1
command line =
bandm/metatools/option/compiler InsertOverprint.options eu.bandm.tools.doctypes.ps InsertOverprintOptions $(HOME)/metatools/src
by program bandm/metatools/option/compiler, version 2.1
command line =
bandm/metatools/option/compiler InsertOverprint.options eu.bandm.tools.doctypes.ps InsertOverprintOptions $(HOME)/metatools/src
-
Nested Class Summary
Modifier and TypeClassDescriptionclass
Programmatically generated catalog of translations.class
One instance realizes one repeated argument group of optiontext
.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 List<InsertOverprintOptions.Values_text>
protected int
protected double
protected String
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.int
Getter method for the only argument of optionangle
.double
Getter method for the only argument of optiongrayvalue
.Getter method for the only argument of optioninputfile
.Getter method for the only argument of optionoutputfile
.get_text()
Getter method for all repetition groups of optiontext
.get_text_0
(int index) Getter method for the only repeated argument of optiontext
.boolean
Deprecated.boolean
Deprecated.boolean
Deprecated.boolean
Deprecated.boolean
has_text()
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, 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_inputfile
protected boolean has_inputfile -
value_inputfile_0
-
has_outputfile
protected boolean has_outputfile -
value_outputfile_0
-
has_text
protected boolean has_text -
repvalues_text
-
serialize_text
-
has_angle
protected boolean has_angle -
value_angle_0
protected int value_angle_0 -
has_grayvalue
protected boolean has_grayvalue -
value_grayvalue_0
protected double value_grayvalue_0
-
-
Constructor Details
-
InsertOverprintOptions
public InsertOverprintOptions()
-
-
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<InsertOverprintOptions>
-
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<InsertOverprintOptions>
-
has_inputfile
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_inputfile_0()
.
-
get_inputfile_0
Getter method for the only argument of optioninputfile
.This option indicates: input file.
The format of this option on the command line is-0 / --inputfile uri(="")
-
has_outputfile
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_outputfile_0()
.
-
get_outputfile_0
Getter method for the only argument of optionoutputfile
.This option indicates: output file.
The format of this option on the command line is-1 / --outputfile uri(="")
-
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()
.
-
get_text
Getter method for all repetition groups of optiontext
.This option indicates: text to overprint on each page.
The format of this option on the command line is-t / --text ( string(="") )+
-
get_text_0
Getter method for the only repeated argument of optiontext
. For details of this option see the methodget_text()
.- Parameters:
index
- the index of the repetition group, zero based.
-
has_angle
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_angle_0()
.
-
get_angle_0
public int get_angle_0()Getter method for the only argument of optionangle
.This option indicates: angle of overprinted text.
The format of this option on the command line is-a / --angle int(=65)
-
has_grayvalue
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_grayvalue_0()
.
-
get_grayvalue_0
public double get_grayvalue_0()Getter method for the only argument of optiongrayvalue
.This option indicates: grey value used for overprinted text.
The format of this option on the command line is-g / --grayvalue float(=0.9)
-
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<InsertOverprintOptions>
-
usage
Print usage information in the default language.- Specified by:
usage
in classModel<InsertOverprintOptions>
-
usage
Print usage information in the requested language. Falls back to default language, if that language is not supported.- Specified by:
usage
in classModel<InsertOverprintOptions>
-
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<InsertOverprintOptions>
- 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<InsertOverprintOptions>
- 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<InsertOverprintOptions>
-
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<InsertOverprintOptions>
-
_finalCheck
protected void _finalCheck()Description copied from class:Model
Callback, overridden by compiled code.- Specified by:
_finalCheck
in classModel<InsertOverprintOptions>
-
_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<InsertOverprintOptions>
-
_getRedundantOptions
Description copied from class:Model
Callback, overridden by compiled code.- Specified by:
_getRedundantOptions
in classModel<InsertOverprintOptions>
-