Uses of Class
org.tquadrat.foundation.config.spi.CLIDefinition
Packages that use CLIDefinition
Package
Description
This module provides a facility for the runtime configuration
of a program.
The API for the Command Line Interface (CLI)
The internal classes for the configuration module.
The classes that are used to implement the functionality of a
configuration bean
-
Uses of CLIDefinition in org.tquadrat.foundation.config
Fields in org.tquadrat.foundation.config with type parameters of type CLIDefinitionModifier and TypeFieldDescriptionprivate final Optional
<CLIDefinition> CmdLineException.m_CLIDefinition
The CLI definition for the argument/option that caused this exception.Methods in org.tquadrat.foundation.config that return types with arguments of type CLIDefinitionModifier and TypeMethodDescriptionfinal Optional
<CLIDefinition> CmdLineException.getCLIDefinition()
Returns theCLIDefinition
that triggered the exception.Methods in org.tquadrat.foundation.config with parameters of type CLIDefinitionModifier and TypeMethodDescriptionstatic final String
ConfigUtil.resolveMessage
(Optional<ResourceBundle> bundle, CLIDefinition definition) Returns the message from the givenCLIDefinition
.Method parameters in org.tquadrat.foundation.config with type arguments of type CLIDefinitionModifier and TypeMethodDescriptionstatic final void
ConfigUtil.dumpParamFileTemplate
(List<? extends CLIDefinition> cmdLineDefinition, OutputStream outputStream) Dumps a parameter file template for the provided command line definition to the givenOutputStream
.static final void
ConfigUtil.parseCommandLine
(Collection<? extends CLIDefinition> cmdLineDefinition, String... args) Parses the given command line arguments based on the provided list ofCLIDefinition
instances.static final void
ConfigUtil.printUsage
(OutputStream outputStream, Optional<ResourceBundle> resources, CharSequence command, Collection<? extends CLIDefinition> definitions) Prints a usage message to the givenOutputStream
.Constructors in org.tquadrat.foundation.config with parameters of type CLIDefinitionModifierConstructorDescriptionCmdLineException
(CLIDefinition cliDefinition, String message, int messageKey, Object... messageArguments) Creates a newCmdLineException
instance.CmdLineException
(CLIDefinition cliDefinition, String message, Throwable cause, int messageKey, Object... messageArguments) Creates a newCmdLineException
instance.CmdLineException
(CLIDefinition cliDefinition, Throwable cause) Creates a newCmdLineException
instance.Constructor parameters in org.tquadrat.foundation.config with type arguments of type CLIDefinitionModifierConstructorDescriptionCmdLineException
(Optional<CLIDefinition> cliDefinition, Throwable cause) Creates a newCmdLineException
instance. -
Uses of CLIDefinition in org.tquadrat.foundation.config.cli
Fields in org.tquadrat.foundation.config.cli declared as CLIDefinitionModifier and TypeFieldDescriptionprivate CLIDefinition
CmdLineValueHandler.m_CLIDefinition
The CLI definition that provides the context for this value handler.Methods in org.tquadrat.foundation.config.cli that return types with arguments of type CLIDefinitionModifier and TypeMethodDescriptionprotected final Optional
<CLIDefinition> CmdLineValueHandler.getCLIDefinition()
Returns a reference to the context.Methods in org.tquadrat.foundation.config.cli with parameters of type CLIDefinitionModifier and TypeMethodDescriptionfinal void
CmdLineValueHandler.setContext
(CLIDefinition context) Sets the CLI definition that provides the context for this value handler.Constructors in org.tquadrat.foundation.config.cli with parameters of type CLIDefinitionModifierConstructorDescriptionBooleanValueHandler
(CLIDefinition context, BiConsumer<String, Boolean> valueSetter) Creates a newBooleanValueHandler
instance.protected
CmdLineValueHandler
(CLIDefinition context, BiConsumer<String, T> valueSetter) Creates a newCmdLineValueHandler
instance.DateValueHandler
(CLIDefinition context, BiConsumer<String, Date> valueSetter) Creates a newDateValueHandler
instance.EnumValueHandler
(CLIDefinition context, Class<T> enumType, BiConsumer<String, T> valueSetter) Creates a newEnumValueHandler
instance.ImageValueHandler
(CLIDefinition context, BiConsumer<String, BufferedImage> valueSetter) Creates a newImageValueHandler
instance.InstantValueHandler
(CLIDefinition context, BiConsumer<String, Instant> valueSetter) Creates a newInstantValueHandler
instance.LocalDateTimeValueHandler
(CLIDefinition context, BiConsumer<String, LocalDateTime> valueSetter) Creates a newLocalDateTimeValueHandler
instance.LocalDateValueHandler
(CLIDefinition context, BiConsumer<String, LocalDate> valueSetter) Creates a newLocalDateValueHandler
instance.LocalTimeValueHandler
(CLIDefinition context, BiConsumer<String, LocalTime> valueSetter) Creates a newLocalTimeValueHandler
instance.SimpleCmdLineValueHandler
(CLIDefinition context, BiConsumer<String, T> valueSetter, StringConverter<? extends T> stringConverter) Creates a newSimpleCmdLineValueHandler
instance.StringValueHandler
(CLIDefinition context, BiConsumer<String, String> valueSetter) Creates a newStringValueHandler
instance.protected
TimeValueHandler
(CLIDefinition context, BiConsumer<String, T> valueSetter, TimeDateStringConverter<T> stringConverter) Creates a newTimeValueHandler
instance.YearMonthValueHandler
(CLIDefinition context, BiConsumer<String, YearMonth> valueSetter) Creates a newYearMonthValueHandler
instance.YearValueHandler
(CLIDefinition context, BiConsumer<String, Year> valueSetter) Creates a newYearValueHandler
instance.YesNoValueHandler
(CLIDefinition context, BiConsumer<String, Boolean> valueSetter) Creates a newYesNoValueHandler
instance.ZonedDateTimeValueHandler
(CLIDefinition context, BiConsumer<String, ZonedDateTime> valueSetter) Creates a newZonedDateTimeValueHandler
instance. -
Uses of CLIDefinition in org.tquadrat.foundation.config.internal
Methods in org.tquadrat.foundation.config.internal that return CLIDefinitionModifier and TypeMethodDescriptionprivate CLIDefinition
CLIDefinitionParser.handleArgument
(StartElement element) Handles the "argument" element.private final CLIDefinition
CLIDefinitionParser.handleOption
(StartElement element) Handles the "option" element.Methods in org.tquadrat.foundation.config.internal that return types with arguments of type CLIDefinitionModifier and TypeMethodDescriptionprivate final List
<CLIDefinition> CLIDefinitionParser.execute()
Executes the parsing.private final List
<CLIDefinition> CLIDefinitionParser.handleCLIDefinition
(StartElement element) Handles the "cliDefinition" element.static final List
<CLIDefinition> CLIDefinitionParser.parse
(InputStream inputStream, Map<String, Object> propertyMap, boolean validate) Parses the givenInputStream
.Methods in org.tquadrat.foundation.config.internal with parameters of type CLIDefinitionModifier and TypeMethodDescriptionprivate final void
ArgumentParser.addArgument
(CLIDefinition definition) Adds an argument definition to the registry for arguments.private final void
ArgumentParser.addOption
(CLIDefinition definition) Adds an option definition to the registry for options.final String
UsageBuilder.resolveMessage
(Optional<ResourceBundle> bundle, CLIDefinition definition) Returns the message from the givenCLIDefinition
Method parameters in org.tquadrat.foundation.config.internal with type arguments of type CLIDefinitionModifier and TypeMethodDescriptionfinal String
UsageBuilder.build
(CharSequence command, Collection<? extends CLIDefinition> definitions) Builds the usage text.Constructor parameters in org.tquadrat.foundation.config.internal with type arguments of type CLIDefinitionModifierConstructorDescriptionArgumentParser
(Collection<? extends CLIDefinition> cliDefinitions) Creates a newArgumentParser
instance. -
Uses of CLIDefinition in org.tquadrat.foundation.config.spi
Subclasses of CLIDefinition in org.tquadrat.foundation.config.spi