Parent class for option descriptors.
Parent class for option descriptors. Each option descriptor contains everything needed to parse that option - option names, defaults, converters, validators, etc.
This trait contains various predefined converters for common use-cases.
This trait contains various predefined converters for common use-cases.
org.rogach.scallop package object inherits from this trait, thus you can
get all the converters simply by importing org.rogach.scallop._
.
Internal class - container for help information for a single option.
A class that lazily encapsulates a map inside.
Descriptor for a property option with a "long" name (like --Props key1=value1 key2=value2
).
Descriptor for a property option with a "long" name (like --Props key1=value1 key2=value2
).
Internal name for the option.
Description for this property option, for help description.
The converter for this option.
Name for 'key' part of this option arg name, as it will appear in help option definition.
Name for 'value' part of this option arg name, as it will appear in help option definition.
If set to true, then this option will be hidden from generated help output.
Descriptor for a number option (-1
or -3
, like GNU tail for example).
Descriptor for a number option (-1
or -3
, like GNU tail for example).
Name for new definition, used for identification.
Is this trailing argument required?
Description for this option, for help text.
The converter for this option.
The function that validates the parsed value.
If this argument is not required and not found in the argument list, use this value.
If set to true then this option will not be present in auto-generated help.
Descriptor for a property option (like -Dkey=value
or -D key1=value1 key2=value2
).
Descriptor for a property option (like -Dkey=value
or -D key1=value1 key2=value2
).
Internal name for the option.
Character that will be used as prefix for property arguments.
Description for this property option, for help description.
The converter for this option.
Name for 'key' part of this option arg name, as it will appear in help option definition.
Name for 'value' part of this option arg name, as it will appear in help option definition.
If set to true, then this option will be hidden from generated help output.
Internal configuration builder.
Base class for CLI parsers.
Contains non-platform-specific functionality of ScallopConf.
Helper trait for generaton of validate
methods on ScallopConf.
Used by ScallopConf.helpFormatter to create help output.
Used by ScallopConf.helpFormatter to create help output. Users of the library can override chosen (or all) methods to tweak help output to their requirements.
A class to hold a reference to not-yet-computed option values.
A class to hold a reference to not-yet-computed option values.
Basically, this is a lazy option - it batches up all operations, and evaluates the value only as the last resort.
Group of options.
Group of options. Options added to the group will be shown before all other options in help output, in the same order as they were added in. (options without groups will be sorted alphabetically and shown after all option groups)
Descriptor for a simple option - describes flag, one-arg or multi-arg options (--opt [ARGS]...).
Descriptor for a simple option - describes flag, one-arg or multi-arg options (--opt [ARGS]...).
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.
Description for this option, for help output.
Is this option required?
The converter for this option.
Default value to use if option is not found in input arguments.
The function that validates the parsed value.
The name for this option argument, as it will appear in help.
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.
Base class for CLI subcommands.
Descriptor for a toggle option (like --verbose/--noverbose
).
Descriptor for a toggle option (like --verbose/--noverbose
).
Name of this option.
Default value for this option.
Overload the char that will be used as short option name.
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.
Is this option required?
If set to true, then this option will not be present in auto-generated help.
Descriptor for a trailing arg option.
Descriptor for a trailing arg option.
Name for new definition, used for identification.
Is this trailing argument required?
Description for this option, for help text.
The converter for this option.
The function that validates the parsed value.
If this argument is not required and not found in the argument list, use this value.
If set to true then this option will not be present in auto-generated help.
Converter from list of plain strings to something meaningful.
An enumeration of possible arg types by number of arguments they can take.
Contains helper functions to handle differences between different platforms (JVM, Native, JS).
Parses the trailing arguments (including the arguments to last option).
Parses the trailing arguments (including the arguments to last option). Uses simple backtraking algorithm.
Creates a converter for an option which accepts multiple arguments.
Creates a converter for an option which accepts multiple arguments.
The conversion function to use on each argument. May throw an exception on error.
A ValueConverter instance.
Handler function for numeric types which expects a NumberFormatException and prints a more helpful error message.
Handler function for numeric types which expects a NumberFormatException and prints a more helpful error message.
the type name to display
Creates a converter for an option with single optional argument
(it will parse both --opt
and --opt arg
command lines).
Creates a converter for an option with single optional argument
(it will parse both --opt
and --opt arg
command lines).
The default value to use if argument wasn't provided.
Converter instance to use if argument was provided.
A ValueConverter instance.
Creates a converter for a property option.
Creates a converter for a property option.
The converter function to use on each value. May throw an exception on error.
A ValueConverter instance.
Creates a converter for an option with a single argument.
Creates a converter for an option with a single argument.
The conversion function to use. May throw an exception on error.
An error handler function for writing custom error messages.
A ValueConverter instance.
Converter for a tally option, used in ScallopConf.tally
Converter for a tally option, used in ScallopConf.tally