public class Options
extends <any>
OptionsGui
. Options()
.
#parse(String[],MessageReceiver)
has_[X]()
. get_[X]_[n]()
. 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.
The usage()
method will show this screen:
=================== command line usage: =================== -v / --version (bool)?(=true iff present) show version number COND=null=mode_0 -m / --mode modes(=null) for what kind of task this application is called -p / --path ( string(="") )* where to look for type definition modules COND=¬modes.dtd2ddf=mode_0 -0 / --source uri(="") path of source file or name of module to process, depends on 'mode' -k / --key string(="") the target language for which documentation shall be generated; or the pair 'module:element' into which xslt code shall be extracted COND=(modes.ddf2doc=mode_0∨modes.ddf2xslt=mode_0) -K / --keys ( string(="") uri(="") )+ pairs of target indications 'module:element' into which the xslt result shall be generated, and the output file position COND=modes.text2texts=mode_0 --additionalSources ( uri(="") )* additional source files, currently only used for documentation and transformation definitions. COND=(modes.ddf2doc=mode_0∨modes.ddf2xslt=mode_0∨modes.text2texts=mode_0) --outputfile uri(="") output file COND=¬modes.text2texts=mode_0 -d / --debug int(=0) debug level, 0=silent 100=maximal verbose COND=¬modes.dtd2ddf=mode_0 --interactive int(=0) which info to print in case of error: (=1) stack situation (=2) generated output so far COND=(modes.text2xml=mode_0∨modes.text2texts=mode_0) --partialdocs (bool)?(=true iff present) whether partially correct but incomplete documents may be produced. COND=(modes.text2xml=mode_0∨modes.text2texts=mode_0) --stylesheetParams ( string(="") string(="") )* explicit pairs key:value of parameters for an xslt style sheet processing. COND=(modes.ddf2doc=mode_0∨modes.text2texts=mode_0) --stylesheetParamFiles ( uri(="") )* list of files containing parameters for xslt processing. COND=(modes.ddf2doc=mode_0∨modes.text2texts=mode_0) --lineWidth int(=70) width of a line for most print out procedures. modes: Select very different operation modes of this tool * text2xml: Translate one(1) d2d text input files into one(1) standard xml file. * text2texts: Translate one d2d text file by xslt into different backend formats (xml or pure text). * test: * ddf2dtd: Generate a standard dtd from a d2d module definition. * ddf2doc: Generate xhtml documentation for a d2d module (select reader's language.) * ddf2xslt: Write out the xslt rules (in d2d format) for a d2d module and a target format * ddf2htmlform: create an xhtml form for a d2d module, seen as input template ???? FIXME * ddf2tsoap: Write down the tsoap serialization of the d2d definition module * ddf2format: Export a pretty-printed source text of the d2d definition module * dtd2ddf: Import a dtd and convert it into a d2d definition module.
Modifier and Type | Class and Description |
---|---|
class |
Options.Descriptions
Programmatically generated catalog of translations.
|
static class |
Options.modes
This enum type indicates: Select very different
operation modes of this tool.
|
class |
Options.Values_additionalSources
One instance realizes one repeated argument group of option
additionalSources . |
class |
Options.Values_keys
One instance realizes one repeated argument group of option
keys . |
class |
Options.Values_path
One instance realizes one repeated argument group of option
path . |
class |
Options.Values_stylesheetParamFiles
One instance realizes one repeated argument group of option
stylesheetParamFiles . |
class |
Options.Values_stylesheetParams
One instance realizes one repeated argument group of option
stylesheetParams . |
Constructor and Description |
---|
Options() |
Modifier and Type | Method and Description |
---|---|
protected void |
_finalCheck() |
String |
_getMissingOptions() |
String |
_getRedundantOptions() |
protected void |
checkActive() |
String |
get_additionalSources_0(int index)
Getter method for the only repeated argument of option
additionalSources . |
List<Options.Values_additionalSources> |
get_additionalSources()
Getter method for all repetition groups of option
additionalSources . |
int |
get_debug_0()
Getter method for the only argument of option
debug . |
int |
get_interactive_0()
Getter method for the only argument of option
interactive . |
String |
get_key_0()
Getter method for the only argument of option
key . |
String |
get_keys_0(int index)
Getter method for the 0th in a group of repeated arguments of option
keys . |
String |
get_keys_1(int index)
Getter method for the 1st in a group of repeated arguments of option
keys . |
List<Options.Values_keys> |
get_keys()
Getter method for all repetition groups of option
keys . |
int |
get_lineWidth_0()
Getter method for the only argument of option
lineWidth . |
Options.modes |
get_mode_0()
Getter method for the only argument of option
mode . |
String |
get_outputfile_0()
Getter method for the only argument of option
outputfile . |
boolean |
get_partialdocs_0()
Getter method for the only argument of option
partialdocs . |
String |
get_path_0(int index)
Getter method for the only repeated argument of option
path . |
List<Options.Values_path> |
get_path()
Getter method for all repetition groups of option
path . |
String |
get_source_0()
Getter method for the only argument of option
source . |
String |
get_stylesheetParamFiles_0(int index)
Getter method for the only repeated argument of option
stylesheetParamFiles . |
List<Options.Values_stylesheetParamFiles> |
get_stylesheetParamFiles()
Getter method for all repetition groups of option
stylesheetParamFiles . |
String |
get_stylesheetParams_0(int index)
Getter method for the 0th in a group of repeated arguments of option
stylesheetParams . |
String |
get_stylesheetParams_1(int index)
Getter method for the 1st in a group of repeated arguments of option
stylesheetParams . |
List<Options.Values_stylesheetParams> |
get_stylesheetParams()
Getter method for all repetition groups of option
stylesheetParams . |
boolean |
get_version_0()
Getter method for the 0th argument of option
version . |
boolean |
has_additionalSources()
Deprecated.
|
boolean |
has_debug()
Deprecated.
|
boolean |
has_interactive()
Deprecated.
|
boolean |
has_key()
Deprecated.
|
boolean |
has_keys()
Deprecated.
|
boolean |
has_lineWidth()
Deprecated.
|
boolean |
has_mode()
Deprecated.
|
boolean |
has_outputfile()
Deprecated.
|
boolean |
has_partialdocs()
Deprecated.
|
boolean |
has_path()
Deprecated.
|
boolean |
has_source()
Deprecated.
|
boolean |
has_stylesheetParamFiles()
Deprecated.
|
boolean |
has_stylesheetParams()
Deprecated.
|
boolean |
has_version()
Deprecated.
|
Options |
makeDefaultInstance() |
protected int |
numberOfPositionals() |
protected void |
parseAbbrev(String select) |
protected void |
parseName(String select) |
protected void |
parsePositionals() |
String |
serialize() |
void |
usage_de()
Print usage information in the language 'de' on System.err.
|
void |
usage_de(PrintStream pr)
Print usage information in the language 'de'.
|
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.
|
protected boolean has_version
protected boolean value_version_0
protected boolean active_version
protected boolean has_mode
protected Options.modes value_mode_0
protected boolean has_path
protected List<Options.Values_path> repvalues_path
public final Function<Options.Values_path,String> serialize_path
protected boolean active_path
protected boolean has_source
protected String value_source_0
protected boolean has_key
protected String value_key_0
protected boolean active_key
protected boolean has_keys
protected List<Options.Values_keys> repvalues_keys
public final Function<Options.Values_keys,String> serialize_keys
protected boolean active_keys
protected boolean has_additionalSources
protected List<Options.Values_additionalSources> repvalues_additionalSources
public final Function<Options.Values_additionalSources,String> serialize_additionalSources
protected boolean active_additionalSources
protected boolean has_outputfile
protected String value_outputfile_0
protected boolean active_outputfile
protected boolean has_debug
protected int value_debug_0
protected boolean active_debug
protected boolean has_interactive
protected int value_interactive_0
protected boolean active_interactive
protected boolean has_partialdocs
protected boolean value_partialdocs_0
protected boolean active_partialdocs
protected boolean has_stylesheetParams
protected List<Options.Values_stylesheetParams> repvalues_stylesheetParams
public final Function<Options.Values_stylesheetParams,String> serialize_stylesheetParams
protected boolean active_stylesheetParams
protected boolean has_stylesheetParamFiles
protected List<Options.Values_stylesheetParamFiles> repvalues_stylesheetParamFiles
public final Function<Options.Values_stylesheetParamFiles,String> serialize_stylesheetParamFiles
protected boolean active_stylesheetParamFiles
protected boolean has_lineWidth
protected int value_lineWidth_0
public Options makeDefaultInstance()
protected void checkActive()
@Deprecated public boolean has_version()
get_version_0()
.public boolean get_version_0()
version
.
-v / --version (bool)?(=true iff present)
@Deprecated public boolean has_mode()
get_mode_0()
.public Options.modes get_mode_0()
mode
.
-m / --mode modes(=null)
@Deprecated public boolean has_path()
get_path()
.public List<Options.Values_path> get_path()
path
.
-p / --path ( string(="") )*
public String get_path_0(int index)
path
.
For details of this option see the method get_path()
.index
- the index of the repetition group, zero based.@Deprecated public boolean has_source()
get_source_0()
.public String get_source_0()
source
.
-0 / --source uri(="")
@Deprecated public boolean has_key()
get_key_0()
.public String get_key_0()
key
.
-k / --key string(="")
@Deprecated public boolean has_keys()
get_keys()
.public List<Options.Values_keys> get_keys()
keys
.
-K / --keys ( string(="") uri(="") )+
public String get_keys_0(int index)
keys
.
For details of this option see the method get_keys()
.index
- the index of the repetition group, zero based.public String get_keys_1(int index)
keys
.
For details of this option see the method get_keys()
.index
- the index of the repetition group, zero based.@Deprecated public boolean has_additionalSources()
get_additionalSources()
.public List<Options.Values_additionalSources> get_additionalSources()
additionalSources
.
--additionalSources ( uri(="") )*
public String get_additionalSources_0(int index)
additionalSources
.
For details of this option see the method get_additionalSources()
.index
- the index of the repetition group, zero based.@Deprecated public boolean has_outputfile()
get_outputfile_0()
.public String get_outputfile_0()
outputfile
.
--outputfile uri(="")
@Deprecated public boolean has_debug()
get_debug_0()
.public int get_debug_0()
debug
.
-d / --debug int(=0)
@Deprecated public boolean has_interactive()
get_interactive_0()
.public int get_interactive_0()
interactive
.
--interactive int(=0)
@Deprecated public boolean has_partialdocs()
get_partialdocs_0()
.public boolean get_partialdocs_0()
partialdocs
.
--partialdocs (bool)?(=true iff present)
@Deprecated public boolean has_stylesheetParams()
get_stylesheetParams()
.public List<Options.Values_stylesheetParams> get_stylesheetParams()
stylesheetParams
.
--stylesheetParams ( string(="") string(="") )*
public String get_stylesheetParams_0(int index)
stylesheetParams
.
For details of this option see the method get_stylesheetParams()
.index
- the index of the repetition group, zero based.public String get_stylesheetParams_1(int index)
stylesheetParams
.
For details of this option see the method get_stylesheetParams()
.index
- the index of the repetition group, zero based.@Deprecated public boolean has_stylesheetParamFiles()
get_stylesheetParamFiles()
.public List<Options.Values_stylesheetParamFiles> get_stylesheetParamFiles()
stylesheetParamFiles
.
--stylesheetParamFiles ( uri(="") )*
public String get_stylesheetParamFiles_0(int index)
stylesheetParamFiles
.
For details of this option see the method get_stylesheetParamFiles()
.index
- the index of the repetition group, zero based.@Deprecated public boolean has_lineWidth()
get_lineWidth_0()
.public int get_lineWidth_0()
lineWidth
.
--lineWidth int(=70)
public String serialize()
public void usage(PrintStream pr)
public void usage(PrintStream pr, String lang)
public void usage_de()
public void usage_de(PrintStream pr)
public void usage_en()
public void usage_en(PrintStream pr)
protected void parseAbbrev(String select)
protected void parseName(String select)
protected int numberOfPositionals()
protected void parsePositionals()
protected void _finalCheck()
public String _getMissingOptions()
public String _getRedundantOptions()
see also the complete user documentation .