Class ToolOptions


public class ToolOptions extends Model<ToolOptions>
Generated source for command line processing.
The parallel GUI class is ToolGui.
The normal way of operation is:
  1. Create a fresh instance by the only constructor ToolOptions().
  2. Analyse command line by invoking Model.parse(String[],MessageReceiver,String)
  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 (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:
 ======
 ---------------------------------------------------------------
 Visibilities for the different categories of DTD components.
 ---------------------------------------------------------------
 --PIs            visibility(=offOn)
 how to treat processing instructions in html rendering
 --comments       visibility(=onOff)
 how to treat comments in html rendering 
 --inserts        visibility(=offOn)
 how to treat file insertions (external 'parameter entities') in html 
    rendering 
 --elements       visibility(=onOff)
 how to treat element declarations in html rendering 
 --attlists       visibility(=onOff)
 how to treat attlist declarations in html rendering 
 --PEs            visibility(=onOff)
 how to treat parameter entitiy declarations in html rendering
 --GEs            visibility(=onOff)
 how to treat general entity declarations in html rendering 
 ------------------------------------------------
 Switches for additional surveys and analyses.
 ------------------------------------------------
 --entityGraph    visibility(=offOn)
 whether to include the entity usage graph 
 --elementGraph   visibility(=onOff)
 whether to include the element contents reference graph 
 --alphabeticDir  visibility(=offOn)
 whether an alphabetic directory for elements, attributes and entities shall 
    be included.. 
 --analyses       visibility(=offOn)
 whether to include diverse analyses' results 
 --commonAttThreshold  int(=1)
 from which multiplicity on a comman attribute shall be listed
 ----------------------------
 Include meta information.
 ----------------------------
 --showFullInstructions  boolean(=true)
 whether to include the full instruction text at the beginning 
 --showCommandLine  boolean(=true)
 whether to print the full command line 
 --showCreationDate  string(="for public use")
 whether to show date and time, plus the additional text 
 -----------------------------------------------
 Select between source text or expanded text.
 -----------------------------------------------
 --expandDefNames  boolean(=false)
 whether entities standing for names in definitions shall be expanded 
 --expandRefTooltips  boolean(=false)
 whether the text in tool-tips for REFERENCES (to elements and entities) shows
    the expanded definition 
 --expandContents  boolean(=false)
 whether the text in content model declarations is expanded (the not-selected 
    form is always in the tool-tip of the defined name!) 
 --expandAttlists  boolean(=false)
 whether the text in attribute lists is expanded (the not-selected form is 
    always in the tool-tip of the defined name!) 
 --expandEntities  boolean(=false)
 whether the text in entity declarations is expanded (the not-selected form is
    always in the tool-tip of the defined name!) 
 -----------------------------------------------------
 Overall operational parameters and style variants.
 -----------------------------------------------------
 --collapseWS     boolean(=true)
 whether to collapse all subsequent white-space when collapsing a declaration 
 --acceptIncomplete  boolean(=false)
 indicates when set that an incomplete DTD, with dangling references (and 
    possibly syntax errors), is nevertheless accepted and rendered, producing 
    warnings instead of errors. 
 --outputFormat   (xhtml | xhtml_stand_alone | xml | text)(=xhtml)
 whether to generate colorful dynamic xhtml, xhtml including script and css, 
    xml for further processing, or pure text like the input format. 
 --gui            boolean(=false)
 whether to show the graphic user interface before any processing (this is 
    also done when command line is totally empty!) 
 --source         uri(="")
 source dtd for processing
 --windowtitle    string(="")
 window title, iff not simply dtd xml coordinates
 --result         uri(="")
 file where to put the result
 --linewidth      int(=78)
 number of columns for generated output
 
 visibility: 
 *               on:    The category does always appear in the rendering.
 *              off:    The category does never appear in the rendering.
 *            onOff:    The category is expandable/collapsable, and initially 
 expanded.
 *            offOn:    The category is expandable/collapsable, and initially 
 collapsed.
 
 
Created on 2024-09-15_20h22m25
by program bandm/metatools/option/compiler, version 2.1
command line =
java bandm/metatools/option/compiler toolOptions.xml eu.bandm.tools.dtm ToolOptions ToolGui $(HOME)/metatools/src
  • Field Details

    • has_PIs

      protected boolean has_PIs
    • value_PIs_0

      protected ToolOptions.visibility value_PIs_0
    • has_comments

      protected boolean has_comments
    • value_comments_0

      protected ToolOptions.visibility value_comments_0
    • has_inserts

      protected boolean has_inserts
    • value_inserts_0

      protected ToolOptions.visibility value_inserts_0
    • has_elements

      protected boolean has_elements
    • value_elements_0

      protected ToolOptions.visibility value_elements_0
    • has_attlists

      protected boolean has_attlists
    • value_attlists_0

      protected ToolOptions.visibility value_attlists_0
    • has_PEs

      protected boolean has_PEs
    • value_PEs_0

      protected ToolOptions.visibility value_PEs_0
    • has_GEs

      protected boolean has_GEs
    • value_GEs_0

      protected ToolOptions.visibility value_GEs_0
    • has_entityGraph

      protected boolean has_entityGraph
    • value_entityGraph_0

      protected ToolOptions.visibility value_entityGraph_0
    • has_elementGraph

      protected boolean has_elementGraph
    • value_elementGraph_0

      protected ToolOptions.visibility value_elementGraph_0
    • has_alphabeticDir

      protected boolean has_alphabeticDir
    • value_alphabeticDir_0

      protected ToolOptions.visibility value_alphabeticDir_0
    • has_analyses

      protected boolean has_analyses
    • value_analyses_0

      protected ToolOptions.visibility value_analyses_0
    • has_commonAttThreshold

      protected boolean has_commonAttThreshold
    • value_commonAttThreshold_0

      protected int value_commonAttThreshold_0
    • has_showFullInstructions

      protected boolean has_showFullInstructions
    • value_showFullInstructions_0

      protected boolean value_showFullInstructions_0
    • has_showCommandLine

      protected boolean has_showCommandLine
    • value_showCommandLine_0

      protected boolean value_showCommandLine_0
    • has_showCreationDate

      protected boolean has_showCreationDate
    • value_showCreationDate_0

      protected String value_showCreationDate_0
    • has_expandDefNames

      protected boolean has_expandDefNames
    • value_expandDefNames_0

      protected boolean value_expandDefNames_0
    • has_expandRefTooltips

      protected boolean has_expandRefTooltips
    • value_expandRefTooltips_0

      protected boolean value_expandRefTooltips_0
    • has_expandContents

      protected boolean has_expandContents
    • value_expandContents_0

      protected boolean value_expandContents_0
    • has_expandAttlists

      protected boolean has_expandAttlists
    • value_expandAttlists_0

      protected boolean value_expandAttlists_0
    • has_expandEntities

      protected boolean has_expandEntities
    • value_expandEntities_0

      protected boolean value_expandEntities_0
    • has_collapseWS

      protected boolean has_collapseWS
    • value_collapseWS_0

      protected boolean value_collapseWS_0
    • has_acceptIncomplete

      protected boolean has_acceptIncomplete
    • value_acceptIncomplete_0

      protected boolean value_acceptIncomplete_0
    • has_outputFormat

      protected boolean has_outputFormat
    • value_outputFormat_0

      protected ToolOptions.outputFormat value_outputFormat_0
    • has_gui

      protected boolean has_gui
    • value_gui_0

      protected boolean value_gui_0
    • has_source

      protected boolean has_source
    • value_source_0

      protected String value_source_0
    • has_windowtitle

      protected boolean has_windowtitle
    • value_windowtitle_0

      protected String value_windowtitle_0
    • has_result

      protected boolean has_result
    • value_result_0

      protected String value_result_0
    • has_linewidth

      protected boolean has_linewidth
    • value_linewidth_0

      protected int value_linewidth_0
  • Constructor Details

    • ToolOptions

      public ToolOptions()
  • Method Details

    • makeDefaultInstance

      public ToolOptions 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 class Model<ToolOptions>
    • 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 class Model<ToolOptions>
    • has_PIs

      @Deprecated public boolean has_PIs()
      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_PIs_0().
    • get_PIs_0

      public ToolOptions.visibility get_PIs_0()
      Getter method for the only argument of option PIs.
      This option indicates: how to treat processing instructions in html rendering.

      The format of this option on the command line is
       
              --PIs            visibility(=offOn)
       
    • has_comments

      @Deprecated public boolean has_comments()
      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_comments_0().
    • get_comments_0

      public ToolOptions.visibility get_comments_0()
      Getter method for the only argument of option comments.
      This option indicates: how to treat comments in html rendering.

      The format of this option on the command line is
       
              --comments       visibility(=onOff)
       
    • has_inserts

      @Deprecated public boolean has_inserts()
      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_inserts_0().
    • get_inserts_0

      public ToolOptions.visibility get_inserts_0()
      Getter method for the only argument of option inserts.
      This option indicates: how to treat file insertions (external 'parameter entities') in html rendering.

      The format of this option on the command line is
       
              --inserts        visibility(=offOn)
       
    • has_elements

      @Deprecated public boolean has_elements()
      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_elements_0().
    • get_elements_0

      public ToolOptions.visibility get_elements_0()
      Getter method for the only argument of option elements.
      This option indicates: how to treat element declarations in html rendering.

      The format of this option on the command line is
       
              --elements       visibility(=onOff)
       
    • has_attlists

      @Deprecated public boolean has_attlists()
      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_attlists_0().
    • get_attlists_0

      public ToolOptions.visibility get_attlists_0()
      Getter method for the only argument of option attlists.
      This option indicates: how to treat attlist declarations in html rendering.

      The format of this option on the command line is
       
              --attlists       visibility(=onOff)
       
    • has_PEs

      @Deprecated public boolean has_PEs()
      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_PEs_0().
    • get_PEs_0

      public ToolOptions.visibility get_PEs_0()
      Getter method for the only argument of option PEs.
      This option indicates: how to treat parameter entitiy declarations in html rendering.

      The format of this option on the command line is
       
              --PEs            visibility(=onOff)
       
    • has_GEs

      @Deprecated public boolean has_GEs()
      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_GEs_0().
    • get_GEs_0

      public ToolOptions.visibility get_GEs_0()
      Getter method for the only argument of option GEs.
      This option indicates: how to treat general entity declarations in html rendering.

      The format of this option on the command line is
       
              --GEs            visibility(=onOff)
       
    • has_entityGraph

      @Deprecated public boolean has_entityGraph()
      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_entityGraph_0().
    • get_entityGraph_0

      public ToolOptions.visibility get_entityGraph_0()
      Getter method for the only argument of option entityGraph.
      This option indicates: whether to include the entity usage graph.

      The format of this option on the command line is
       
              --entityGraph    visibility(=offOn)
       
    • has_elementGraph

      @Deprecated public boolean has_elementGraph()
      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_elementGraph_0().
    • get_elementGraph_0

      public ToolOptions.visibility get_elementGraph_0()
      Getter method for the only argument of option elementGraph.
      This option indicates: whether to include the element contents reference graph.

      The format of this option on the command line is
       
              --elementGraph   visibility(=onOff)
       
    • has_alphabeticDir

      @Deprecated public boolean has_alphabeticDir()
      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_alphabeticDir_0().
    • get_alphabeticDir_0

      public ToolOptions.visibility get_alphabeticDir_0()
      Getter method for the only argument of option alphabeticDir.
      This option indicates: whether an alphabetic directory for elements, attributes and entities shall be included..

      The format of this option on the command line is
       
              --alphabeticDir  visibility(=offOn)
       
    • has_analyses

      @Deprecated public boolean has_analyses()
      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_analyses_0().
    • get_analyses_0

      public ToolOptions.visibility get_analyses_0()
      Getter method for the only argument of option analyses.
      This option indicates: whether to include diverse analyses' results.

      The format of this option on the command line is
       
              --analyses       visibility(=offOn)
       
    • has_commonAttThreshold

      @Deprecated public boolean has_commonAttThreshold()
      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_commonAttThreshold_0().
    • get_commonAttThreshold_0

      public int get_commonAttThreshold_0()
      Getter method for the only argument of option commonAttThreshold.
      This option indicates: from which multiplicity on a comman attribute shall be listed.

      The format of this option on the command line is
       
              --commonAttThreshold  int(=1)
       
    • has_showFullInstructions

      @Deprecated public boolean has_showFullInstructions()
      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_showFullInstructions_0().
    • get_showFullInstructions_0

      public boolean get_showFullInstructions_0()
      Getter method for the only argument of option showFullInstructions.
      This option indicates: whether to include the full instruction text at the beginning.

      The format of this option on the command line is
       
              --showFullInstructions  boolean(=true)
       
    • has_showCommandLine

      @Deprecated public boolean has_showCommandLine()
      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_showCommandLine_0().
    • get_showCommandLine_0

      public boolean get_showCommandLine_0()
      Getter method for the only argument of option showCommandLine.
      This option indicates: whether to print the full command line.

      The format of this option on the command line is
       
              --showCommandLine  boolean(=true)
       
    • has_showCreationDate

      @Deprecated public boolean has_showCreationDate()
      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_showCreationDate_0().
    • get_showCreationDate_0

      public String get_showCreationDate_0()
      Getter method for the only argument of option showCreationDate.
      This option indicates: whether to show date and time, plus the additional text.

      The format of this option on the command line is
       
              --showCreationDate  string(="for public use")
       
    • has_expandDefNames

      @Deprecated public boolean has_expandDefNames()
      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_expandDefNames_0().
    • get_expandDefNames_0

      public boolean get_expandDefNames_0()
      Getter method for the only argument of option expandDefNames.
      This option indicates: whether entities standing for names in definitions shall be expanded.

      The format of this option on the command line is
       
              --expandDefNames  boolean(=false)
       
    • has_expandRefTooltips

      @Deprecated public boolean has_expandRefTooltips()
      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_expandRefTooltips_0().
    • get_expandRefTooltips_0

      public boolean get_expandRefTooltips_0()
      Getter method for the only argument of option expandRefTooltips.
      This option indicates: whether the text in tool-tips for REFERENCES (to elements and entities) shows the expanded definition.

      The format of this option on the command line is
       
              --expandRefTooltips  boolean(=false)
       
    • has_expandContents

      @Deprecated public boolean has_expandContents()
      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_expandContents_0().
    • get_expandContents_0

      public boolean get_expandContents_0()
      Getter method for the only argument of option expandContents.
      This option indicates: whether the text in content model declarations is expanded (the not-selected form is always in the tool-tip of the defined name!).

      The format of this option on the command line is
       
              --expandContents  boolean(=false)
       
    • has_expandAttlists

      @Deprecated public boolean has_expandAttlists()
      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_expandAttlists_0().
    • get_expandAttlists_0

      public boolean get_expandAttlists_0()
      Getter method for the only argument of option expandAttlists.
      This option indicates: whether the text in attribute lists is expanded (the not-selected form is always in the tool-tip of the defined name!).

      The format of this option on the command line is
       
              --expandAttlists  boolean(=false)
       
    • has_expandEntities

      @Deprecated public boolean has_expandEntities()
      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_expandEntities_0().
    • get_expandEntities_0

      public boolean get_expandEntities_0()
      Getter method for the only argument of option expandEntities.
      This option indicates: whether the text in entity declarations is expanded (the not-selected form is always in the tool-tip of the defined name!).

      The format of this option on the command line is
       
              --expandEntities  boolean(=false)
       
    • has_collapseWS

      @Deprecated public boolean has_collapseWS()
      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_collapseWS_0().
    • get_collapseWS_0

      public boolean get_collapseWS_0()
      Getter method for the only argument of option collapseWS.
      This option indicates: whether to collapse all subsequent white-space when collapsing a declaration.

      The format of this option on the command line is
       
              --collapseWS     boolean(=true)
       
    • has_acceptIncomplete

      @Deprecated public boolean has_acceptIncomplete()
      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_acceptIncomplete_0().
    • get_acceptIncomplete_0

      public boolean get_acceptIncomplete_0()
      Getter method for the only argument of option acceptIncomplete.
      This option indicates: indicates when set that an incomplete DTD, with dangling references (and possibly syntax errors), is nevertheless accepted and rendered, producing warnings instead of errors.

      The format of this option on the command line is
       
              --acceptIncomplete  boolean(=false)
       
    • has_outputFormat

      @Deprecated public boolean has_outputFormat()
      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_outputFormat_0().
    • get_outputFormat_0

      public ToolOptions.outputFormat get_outputFormat_0()
      Getter method for the only argument of option outputFormat.
      This option indicates: whether to generate colorful dynamic xhtml, xhtml including script and css, xml for further processing, or pure text like the input format.

      The format of this option on the command line is
       
              --outputFormat   (xhtml | xhtml_stand_alone | xml | text)(=xhtml)
       
    • has_gui

      @Deprecated public boolean has_gui()
      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_gui_0().
    • get_gui_0

      public boolean get_gui_0()
      Getter method for the only argument of option gui.
      This option indicates: whether to show the graphic user interface before any processing (this is also done when command line is totally empty!).

      The format of this option on the command line is
       
              --gui            boolean(=false)
       
    • has_source

      @Deprecated public boolean has_source()
      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_source_0().
    • get_source_0

      public String get_source_0()
      Getter method for the only argument of option source.
      This option indicates: source dtd for processing.

      The format of this option on the command line is
       
              --source         uri(="")
       
    • has_windowtitle

      @Deprecated public boolean has_windowtitle()
      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_windowtitle_0().
    • get_windowtitle_0

      public String get_windowtitle_0()
      Getter method for the only argument of option windowtitle.
      This option indicates: window title, iff not simply dtd xml coordinates.

      The format of this option on the command line is
       
              --windowtitle    string(="")
       
    • has_result

      @Deprecated public boolean has_result()
      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_result_0().
    • get_result_0

      public String get_result_0()
      Getter method for the only argument of option result.
      This option indicates: file where to put the result.

      The format of this option on the command line is
       
              --result         uri(="")
       
    • has_linewidth

      @Deprecated public boolean has_linewidth()
      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_linewidth_0().
    • get_linewidth_0

      public int get_linewidth_0()
      Getter method for the only argument of option linewidth.
      This option indicates: number of columns for generated output.

      The format of this option on the command line is
       
              --linewidth      int(=78)
       
    • serialize

      public 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 class Model<ToolOptions>
    • usage

      public void usage(PrintStream pr)
      Print usage information in the default language.
      Specified by:
      usage in class Model<ToolOptions>
    • 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.
      Specified by:
      usage in class Model<ToolOptions>
    • 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)
      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 class Model<ToolOptions>
      Parameters:
      select - the one-character option name, as parsed by this code.
    • parseName

      protected void parseName(String select)
      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 class Model<ToolOptions>
      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 class Model<ToolOptions>
    • 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 class Model<ToolOptions>
    • _finalCheck

      protected void _finalCheck()
      Description copied from class: Model
      Callback, overridden by compiled code.
      Specified by:
      _finalCheck in class Model<ToolOptions>
    • _getMissingOptions

      public String _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 class Model<ToolOptions>
    • _getRedundantOptions

      public String _getRedundantOptions()
      Description copied from class: Model
      Callback, overridden by compiled code.
      Specified by:
      _getRedundantOptions in class Model<ToolOptions>