Arguments to parse.
Options definitions.
Names of options, that are to be printed first in the help printout
Version string to display in help.
Banner (summary of this program and command-line usage) to display in help.
Footer - displayed after options.
Short description - used for subcommands
Width, to which the help output will be formatted (note that banner, footer, version and description are not affected!)
If true, then help output from this builder wouldn't list full help for subcommands, only short description
subcommands in this builder
Adds a subbuilder (subcommand) to this builder.
Get the value of option.
Get the value of option. If option is not found, this will throw an exception.
Name for option.
Add some more arguments to this builder.
Add some more arguments to this builder. They are appended to the end of the original list.
arg list to add
Arguments to parse.
Banner (summary of this program and command-line usage) to display in help.
Add banner string to this builder.
Add banner string to this builder. Banner should describe your program and provide a short summary on it's usage.
Banner string, can contain multiple lines. Note this is not formatted to 80 characters!
Short description - used for subcommands
Get summary of current parser state + blurring the values of parameters provided.
Get summary of current parser state + blurring the values of parameters provided.
names of arguments that should be hidden. Returns a list of all options in the builder, and corresponding values for them with eventually blurred values.
Traverses the tree of subbuilders, using the provided name.
Traverses the tree of subbuilders, using the provided name.
Names of subcommand names, that lead to the needed builder, separated by \\0.
Footer - displayed after options.
Add footer string to this builder.
Add footer string to this builder. Footer will be printed in help after option definitions.
Footer string, can contain multiple lines. Note this is not formatted to 80 characters!
Get the value of option (or trailing arg) as Option.
Get the value of option (or trailing arg) as Option.
Name for option.
Retrieves a list of all supplied options (including options from subbuilders).
Find an option, that responds to this short name.
Retrieves the subbuilder object, that matches the name of the subcommand found in input arguments.
Returns the subcommand arguments.
Retrieves name of the subcommand that was found in input arguments.
Returns the list of subcommand names, recursively.
Get help on options from this builder.
Get help on options from this builder. The resulting help is carefully formatted to required number of columns (default = 80, change with .setHelpWidth method), and contains info on properties, options and trailing arguments.
Width, to which the help output will be formatted (note that banner, footer, version and description are not affected!)
Tests if this option or trailing arg was explicitly provided by argument list (not from default).
Tests if this option or trailing arg was explicitly provided by argument list (not from default).
Identifier of option or trailing arg definition
Names of options, that are to be printed first in the help printout
Add new number argument definition to this builder.
Add new number argument definition to this builder.
Name for new definition, used for identification.
Is this trailing argument required? Defaults to true.
Description for this option, for help text.
If this argument is not required and not found in the argument list, use this value.
The function that validates the parsed value.
If set to true then this option will not be present in auto-generated help.
Add a new option definition to this builder.
Add a new option definition to this builder.
Name for new option, used as long option name in parsing, and for option identification.
Overload the char that will be used as short option name. Defaults to first character of the name.
Description for this option, for help description.
Default value to use if option is not found in input arguments (if you provide this, you can omit the type on method).
The function, that validates the parsed value
Is this option required? Defaults to false.
The name for this ortion argument, as it will appear in help. Defaults to "arg".
Hides description of this option from help (this can be useful for debugging options)
If set to true, then this option does not have any short name.
The converter for this option. Usually found implicitly.
Options definitions.
Print help message (with version, banner, option usage and footer) to stdout.
Add new property option definition to this builder.
Add new property option definition to this builder.
Char, that will be used as prefix for property arguments.
Description for this property option, for help description.
Name for 'key' part of this option arg name, as it will appear in help option definition. Defaults to "key".
Name for 'value' part of this option arg name, as it will appear in help option definition. Defaults to "value".
Explicitly sets the needed width for the help printout.
If true, then help output from this builder wouldn't list full help for subcommands, only short description
subcommands in this builder
Get summary of current parser state.
Get summary of current parser state.
Returns a list of all options in the builder, and corresponding values for them.
Add new toggle option definition to this builer.
Add new toggle option definition to this builer.
Name for new definition, used for identification.
Default value
Name for short form of this option
If set to true, then this option will not have any short name.
Prefix to name of the option, that will be used for "negative" version of the option.
Description for positive variant of this option.
Description for negative variant of this option.
If set to true, then this option will not be present in auto-generated help.
Add new trailing argument definition to this builder.
Add new trailing argument definition to this builder.
Name for new definition, used for identification.
Is this trailing argument required? Defaults to true.
Description for this option, for help text.
If this argument is not required and not found in the argument list, use this value.
The function, that validates the parsed value
Verify the builder.
Verify the builder. Parses arguments, makes sure no definitions clash, no garbage or unknown options are present, and all present arguments are in proper format. It is recommended to call this method before using the results.
If there is "--help" or "--version" option present, it prints help or version statement and exits.
Version string to display in help.
Add version string to this builder.
Add version string to this builder.
Version string, to be printed before all other things in help.
The main builder class.
Arguments to parse.
Options definitions.
Names of options, that are to be printed first in the help printout
Version string to display in help.
Banner (summary of this program and command-line usage) to display in help.
Footer - displayed after options.
Short description - used for subcommands
Width, to which the help output will be formatted (note that banner, footer, version and description are not affected!)
If true, then help output from this builder wouldn't list full help for subcommands, only short description
subcommands in this builder