Uses of Class
com.github.rvesse.airline.model.ArgumentsMetadata
Packages that use ArgumentsMetadata
Package
Description
-
Uses of ArgumentsMetadata in com.github.rvesse.airline.examples.userguide.restrictions.custom
Methods in com.github.rvesse.airline.examples.userguide.restrictions.custom with parameters of type ArgumentsMetadataModifier and TypeMethodDescription<T> void
MultipleOfRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) -
Uses of ArgumentsMetadata in com.github.rvesse.airline.help.cli
Methods in com.github.rvesse.airline.help.cli with parameters of type ArgumentsMetadataModifier and TypeMethodDescription<T> void
CliUsageHelper.outputArguments
(UsagePrinter out, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig) protected void
CliUsageHelper.outputArgumentsRestriction
(UsagePrinter descriptionPrinter, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an optionprotected <T> void
CliCommandUsageGenerator.outputOptionsAndArguments
(UsagePrinter out, CommandMetadata command, List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig) Outputs a documentation section detailing options and their usages -
Uses of ArgumentsMetadata in com.github.rvesse.airline.help.cli.bash
Methods in com.github.rvesse.airline.help.cli.bash with parameters of type ArgumentsMetadataModifier and TypeMethodDescriptionprotected BashCompletion
BashCompletionGenerator.getCompletionData
(ArgumentsMetadata arguments) Gets the completion info for arguments -
Uses of ArgumentsMetadata in com.github.rvesse.airline.help.common
Methods in com.github.rvesse.airline.help.common with parameters of type ArgumentsMetadataModifier and TypeMethodDescriptionprotected String
AbstractUsageGenerator.toDescription
(ArgumentsMetadata arguments) protected String
AbstractUsageGenerator.toUsage
(ArgumentsMetadata arguments) -
Uses of ArgumentsMetadata in com.github.rvesse.airline.help.html
Methods in com.github.rvesse.airline.help.html with parameters of type ArgumentsMetadataModifier and TypeMethodDescriptionprotected <T> void
HtmlCommandUsageGenerator.outputOptions
(Writer writer, List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig) Outputs a documentation section detailing the options -
Uses of ArgumentsMetadata in com.github.rvesse.airline.help.man
Methods in com.github.rvesse.airline.help.man with parameters of type ArgumentsMetadataModifier and TypeMethodDescription<T> void
ManUsageHelper.outputArguments
(TroffPrinter printer, ArgumentsMetadata arguments, boolean startList, ParserMetadata<T> parserConfig) protected void
ManUsageHelper.outputArgumentsRestriction
(TroffPrinter printer, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an optionvoid
ManUsageHelper.outputArgumentsSynopsis
(TroffPrinter printer, ArgumentsMetadata arguments) void
ManUsageHelper.outputArgumentsTitle
(TroffPrinter printer, ArgumentsMetadata arguments) -
Uses of ArgumentsMetadata in com.github.rvesse.airline.help.markdown
Methods in com.github.rvesse.airline.help.markdown with parameters of type ArgumentsMetadataModifier and TypeMethodDescription<T> void
MarkdownUsageHelper.outputArguments
(UsagePrinter out, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig) protected void
MarkdownUsageHelper.outputArgumentsRestriction
(UsagePrinter descriptionPrinter, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an optionvoid
MarkdownUsageHelper.outputArgumentsSynopsis
(UsagePrinter printer, ArgumentsMetadata arguments) void
MarkdownUsageHelper.outputArgumentsTitle
(UsagePrinter printer, ArgumentsMetadata arguments) protected <T> void
MarkdownCommandUsageGenerator.outputOptionsAndArguments
(UsagePrinter out, CommandMetadata command, List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig) Outputs a documentation section detailing options and their usages -
Uses of ArgumentsMetadata in com.github.rvesse.airline.model
Fields in com.github.rvesse.airline.model declared as ArgumentsMetadataFields in com.github.rvesse.airline.model with type parameters of type ArgumentsMetadataModifier and TypeFieldDescriptionprivate List
<ArgumentsMetadata> MetadataLoader.InjectionMetadata.arguments
Methods in com.github.rvesse.airline.model that return ArgumentsMetadataConstructors in com.github.rvesse.airline.model with parameters of type ArgumentsMetadataModifierConstructorDescriptionCommandMetadata
(String name, String description, boolean hidden, Iterable<OptionMetadata> globalOptions, Iterable<OptionMetadata> groupOptions, Iterable<OptionMetadata> commandOptions, OptionMetadata defaultOption, ArgumentsMetadata arguments, Iterable<Accessor> metadataInjections, Class<?> type, List<String> groupNames, List<Group> groups, List<HelpSection> sections) Constructor parameters in com.github.rvesse.airline.model with type arguments of type ArgumentsMetadata -
Uses of ArgumentsMetadata in com.github.rvesse.airline.parser
Methods in com.github.rvesse.airline.parser with parameters of type ArgumentsMetadataModifier and TypeMethodDescriptionstatic <T> T
ParserUtil.createInstance
(Class<?> type, Iterable<OptionMetadata> options, List<org.apache.commons.lang3.tuple.Pair<OptionMetadata, Object>> parsedOptions, ArgumentsMetadata arguments, Iterable<Object> parsedArguments, Iterable<Accessor> metadataInjection, Map<Class<?>, Object> bindings) static <T> T
ParserUtil.createInstance
(Class<?> type, Iterable<OptionMetadata> options, List<org.apache.commons.lang3.tuple.Pair<OptionMetadata, Object>> parsedOptions, ArgumentsMetadata arguments, Iterable<Object> parsedArguments, Iterable<Accessor> metadataInjection, Map<Class<?>, Object> bindings, CommandFactory<T> commandFactory) static <T> T
ParserUtil.injectOptions
(T commandInstance, Iterable<OptionMetadata> options, List<org.apache.commons.lang3.tuple.Pair<OptionMetadata, Object>> parsedOptions, ArgumentsMetadata arguments, Iterable<Object> parsedArguments, Iterable<Accessor> metadataInjection, Map<Class<?>, Object> bindings) private ParseState
<T> AbstractCommandParser.parseArg
(ParseState<T> state, org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ArgumentsMetadata arguments, OptionMetadata defaultOption) private ParseState
<T> AbstractCommandParser.parseArgs
(ParseState<T> state, org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ArgumentsMetadata arguments, OptionMetadata defaultOption) ParseState.withArgument
(ArgumentsMetadata arguments, String rawValue) -
Uses of ArgumentsMetadata in com.github.rvesse.airline.restrictions
Methods in com.github.rvesse.airline.restrictions with parameters of type ArgumentsMetadataModifier and TypeMethodDescription<T> void
AbstractCommonRestriction.finalValidate
(ParseState<T> state, ArgumentsMetadata arguments) <T> void
ArgumentsRestriction.finalValidate
(ParseState<T> state, ArgumentsMetadata arguments) Method that is called after Airline has completed parsingstatic <T> String
AbstractCommonRestriction.getArgumentTitle
(ArgumentsMetadata arguments, int argIndex) static <T> String
AbstractCommonRestriction.getArgumentTitle
(ParseState<T> state, ArgumentsMetadata arguments) <T> void
AbstractCommonRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) <T> void
ArgumentsRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) Method that is called after Airline has converted a string argument received into a strongly typed Java value<T> void
AbstractCommonRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) <T> void
ArgumentsRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value -
Uses of ArgumentsMetadata in com.github.rvesse.airline.restrictions.common
Methods in com.github.rvesse.airline.restrictions.common with parameters of type ArgumentsMetadataModifier and TypeMethodDescription<T> void
IsRequiredRestriction.finalValidate
(ParseState<T> state, ArgumentsMetadata arguments) <T> void
OccurrencesRestriction.finalValidate
(ParseState<T> state, ArgumentsMetadata arguments) protected void
PortRestriction.invalidArgumentsPort
(ArgumentsMetadata arguments, String title, Object value) <T> void
AllowedValuesRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) <T> void
PartialRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) <T> void
PortRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) <T> void
PositiveNegativeRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) <T> void
RangeRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) final <T> void
AbstractStringRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) <T> void
AllowedEnumValuesRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) <T> void
AllowedRawValuesRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) <T> void
PartialRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) <T> void
PathRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) <T> void
PatternRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) OccurrencesRestriction.titles
(ParseState<T> state, ArgumentsMetadata arguments) protected abstract <T> ParseRestrictionViolatedException
AbstractStringRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) Method that derived classes must implement to provide an exception for the case of an invalid argument value, this will be called ifAbstractStringRestriction.isValid(String)
returnsfalse
protected <T> ParseRestrictionViolatedException
EndsWithRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) protected <T> ParseRestrictionViolatedException
LengthRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) protected <T> ParseRestrictionViolatedException
NoOptionLikeValuesRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) protected <T> ParseRestrictionViolatedException
NotBlankRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) protected <T> ParseRestrictionViolatedException
NotEmptyRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) protected <T> ParseRestrictionViolatedException
StartsWithRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) -
Uses of ArgumentsMetadata in com.github.rvesse.airline.restrictions.options
Methods in com.github.rvesse.airline.restrictions.options with parameters of type ArgumentsMetadataModifier and TypeMethodDescription<T> void
AbstractRequiredUnlessRestriction.finalValidate
(ParseState<T> state, ArgumentsMetadata arguments) protected abstract <T> boolean
AbstractRequiredUnlessRestriction.unless
(ParseState<T> state, ArgumentsMetadata arguments) Answers whether the unless condition of the restriction is metprotected <T> boolean
RequiredUnlessEnvironmentRestriction.unless
(ParseState<T> state, ArgumentsMetadata arguments) -
Uses of ArgumentsMetadata in com.github.rvesse.airline.types
Methods in com.github.rvesse.airline.types with parameters of type ArgumentsMetadataModifier and TypeMethodDescription<T> TypeConverter
DefaultTypeConverterProvider.getTypeConverter
(ArgumentsMetadata arguments, ParseState<T> state) <T> TypeConverter
TypeConverterProvider.getTypeConverter
(ArgumentsMetadata arguments, ParseState<T> state) Gets the type converter to use for the given arguments and parser state -
Uses of ArgumentsMetadata in com.github.rvesse.airline.types.numerics
Methods in com.github.rvesse.airline.types.numerics with parameters of type ArgumentsMetadataModifier and TypeMethodDescription<T> TypeConverter
DefaultNumericConverter.getTypeConverter
(ArgumentsMetadata arguments, ParseState<T> state)