config library
Classes
- BoolParser
- Parses a boolean value from a string.
-
ComparableValueOption<
V extends Comparable> - Base class for configuration options that support minimum and maximum range checking.
-
ConfigOptionBase<
V> - Defines a configuration option that can be set from configuration sources.
- ConfigParser
- A backwards compatible parser for command args and configuration sources.
- ConfigResults
-
A wrapper around a Configuration object that implements the
ArgResultsinterface. This is returned by the ConfigParser.parse method. -
ConfigSourceProvider<
O extends OptionDefinition> - Provider of a ConfigurationSource that is dynamically based on the current configuration.
-
Configuration<
O extends OptionDefinition> - A configuration object that holds the values for a set of configuration options.
-
ConfigurationBroker<
O extends OptionDefinition> - Resolves configuration values dynamically and possibly from multiple sources.
- ConfigurationParser
- Parsers for various configuration data sources.
- ConfigurationSource
- A source of configuration values.
- DateTimeOption
- Date-time value configuration option.
- DateTimeParser
- Parses a date string into a DateTime object. Throws FormatException if parsing failed.
- DirOption
- Directory path configuration option.
- DirParser
- DurationOption
- Duration value configuration option.
- DurationParser
- Parses a duration string into a Duration object.
-
EnumOption<
E extends Enum> - Enum value configuration option.
-
EnumParser<
E extends Enum> - Parses a string value into an enum value. Currently requires an exact, case-sensitive match.
- FileOption
- File path configuration option.
- FileParser
- FlagOption
- Boolean value configuration option.
- IntOption
- Integer value configuration option.
- IntParser
- MapConfigSource
- Simple ConfigurationSource adapter for a Map<String, String>.
-
MultiDomainConfigBroker<
O extends OptionDefinition> - A ConfigurationBroker that combines configuration sources from multiple providers, called configuration domains.
-
MultiOption<
T> - Multi-value configuration option.
-
MultiParser<
T> - Parses a list of values from a comma-separated string.
- MultiStringOption
- Convenience class for multi-value configuration option for strings.
- MutuallyExclusive
- An option group for mutually exclusive options.
-
OptionContentConfigProvider<
O extends OptionDefinition< String> > - A ConfigSourceProvider that uses the value of an option as data source.
-
OptionDefinition<
V> - Common interface to enable same treatment for ConfigOptionBase and option enums.
- OptionGroup
- An option group allows grouping options together under a common name, and optionally provide option value validation on the group as a whole.
- StringOption
- String value configuration option.
- StringParser
- ValueParser that returns the input string unchanged.
-
ValueParser<
V> - A ValueParser converts a source string value to the specific option value type.
Enums
- ConfigEncoding
- Encoding format of a configuration data source.
- DurationUnit
- The time units supported by the DurationParser.
- MutuallyExclusiveMode
- PathExistMode
- ValueSourceType
- The type of source that an option's value was resolved from.
Extensions
-
PrepareOptions
on Iterable<
OptionDefinition> - QualifiedString on OptionDefinition
- Extension to add a qualifiedString shorthand method to OptionDefinition. Since enum classes that implement OptionDefinition don't inherit its method implementations, this extension provides this method implementation instead.
Functions
-
addOptionsToParser(
Iterable< OptionDefinition> argNameOpts, ArgParser argParser, {bool addGroupSeparators = false}) → void -
Adds
argNameOptstoargParser. -
formatConfigError(
String error) → String - Formats a configuration error message.
-
prepareOptionsForParsing(
Iterable< OptionDefinition> options, ArgParser argParser) → void - Validates and prepares a set of options for the provided argument parser.
-
validateOptions(
Iterable< OptionDefinition> options) → Iterable<OptionDefinition>
Exceptions / Errors
- InvalidParseStateError
- Specialized StateError that indicates that the configuration has not been successfully parsed and this prevents accessing some or all of the configuration values.
- OptionDefinitionError
- Indicates that the option definition is invalid.
- UsageException