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_CLIDefinitionThe 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 theCLIDefinitionthat triggered the exception.Methods in org.tquadrat.foundation.config with parameters of type CLIDefinitionModifier and TypeMethodDescriptionstatic final StringConfigUtil.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 voidConfigUtil.dumpParamFileTemplate(List<? extends CLIDefinition> cmdLineDefinition, OutputStream outputStream) Dumps a parameter file template for the provided command line definition to the givenOutputStream.static final voidConfigUtil.parseCommandLine(Collection<? extends CLIDefinition> cmdLineDefinition, String... args) Parses the given command line arguments based on the provided list ofCLIDefinitioninstances.static final voidConfigUtil.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 newCmdLineExceptioninstance.CmdLineException(CLIDefinition cliDefinition, String message, Throwable cause, int messageKey, Object... messageArguments) Creates a newCmdLineExceptioninstance.CmdLineException(CLIDefinition cliDefinition, Throwable cause) Creates a newCmdLineExceptioninstance.Constructor parameters in org.tquadrat.foundation.config with type arguments of type CLIDefinitionModifierConstructorDescriptionCmdLineException(Optional<CLIDefinition> cliDefinition, Throwable cause) Creates a newCmdLineExceptioninstance. -
Uses of CLIDefinition in org.tquadrat.foundation.config.cli
Fields in org.tquadrat.foundation.config.cli declared as CLIDefinitionModifier and TypeFieldDescriptionprivate CLIDefinitionCmdLineValueHandler.m_CLIDefinitionThe 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 voidCmdLineValueHandler.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 newBooleanValueHandlerinstance.protectedCmdLineValueHandler(CLIDefinition context, BiConsumer<String, T> valueSetter) Creates a newCmdLineValueHandlerinstance.DateValueHandler(CLIDefinition context, BiConsumer<String, Date> valueSetter) Creates a newDateValueHandlerinstance.EnumValueHandler(CLIDefinition context, Class<T> enumType, BiConsumer<String, T> valueSetter) Creates a newEnumValueHandlerinstance.ImageValueHandler(CLIDefinition context, BiConsumer<String, BufferedImage> valueSetter) Creates a newImageValueHandlerinstance.InstantValueHandler(CLIDefinition context, BiConsumer<String, Instant> valueSetter) Creates a newInstantValueHandlerinstance.LocalDateTimeValueHandler(CLIDefinition context, BiConsumer<String, LocalDateTime> valueSetter) Creates a newLocalDateTimeValueHandlerinstance.LocalDateValueHandler(CLIDefinition context, BiConsumer<String, LocalDate> valueSetter) Creates a newLocalDateValueHandlerinstance.LocalTimeValueHandler(CLIDefinition context, BiConsumer<String, LocalTime> valueSetter) Creates a newLocalTimeValueHandlerinstance.SimpleCmdLineValueHandler(CLIDefinition context, BiConsumer<String, T> valueSetter, StringConverter<? extends T> stringConverter) Creates a newSimpleCmdLineValueHandlerinstance.StringValueHandler(CLIDefinition context, BiConsumer<String, String> valueSetter) Creates a newStringValueHandlerinstance.protectedTimeValueHandler(CLIDefinition context, BiConsumer<String, T> valueSetter, TimeDateStringConverter<T> stringConverter) Creates a newTimeValueHandlerinstance.YearMonthValueHandler(CLIDefinition context, BiConsumer<String, YearMonth> valueSetter) Creates a newYearMonthValueHandlerinstance.YearValueHandler(CLIDefinition context, BiConsumer<String, Year> valueSetter) Creates a newYearValueHandlerinstance.YesNoValueHandler(CLIDefinition context, BiConsumer<String, Boolean> valueSetter) Creates a newYesNoValueHandlerinstance.ZonedDateTimeValueHandler(CLIDefinition context, BiConsumer<String, ZonedDateTime> valueSetter) Creates a newZonedDateTimeValueHandlerinstance. -
Uses of CLIDefinition in org.tquadrat.foundation.config.internal
Methods in org.tquadrat.foundation.config.internal that return CLIDefinitionModifier and TypeMethodDescriptionprivate CLIDefinitionCLIDefinitionParser.handleArgument(StartElement element) Handles the "argument" element.private final CLIDefinitionCLIDefinitionParser.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 voidArgumentParser.addArgument(CLIDefinition definition) Adds an argument definition to the registry for arguments.private final voidArgumentParser.addOption(CLIDefinition definition) Adds an option definition to the registry for options.final StringUsageBuilder.resolveMessage(Optional<ResourceBundle> bundle, CLIDefinition definition) Returns the message from the givenCLIDefinitionMethod parameters in org.tquadrat.foundation.config.internal with type arguments of type CLIDefinitionModifier and TypeMethodDescriptionfinal StringUsageBuilder.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 newArgumentParserinstance. -
Uses of CLIDefinition in org.tquadrat.foundation.config.spi
Subclasses of CLIDefinition in org.tquadrat.foundation.config.spi
