Uses of Class
com.github.rvesse.airline.model.ArgumentsMetadata
-
-
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 ArgumentsMetadata Modifier and Type Method Description <T> void
MultipleOfRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)
-
Uses of ArgumentsMetadata in com.github.rvesse.airline.help.cli
Methods in com.github.rvesse.airline.help.cli with parameters of type ArgumentsMetadata Modifier and Type Method Description <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, java.util.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 ArgumentsMetadata Modifier and Type Method Description protected 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 ArgumentsMetadata Modifier and Type Method Description protected java.lang.String
AbstractUsageGenerator. toDescription(ArgumentsMetadata arguments)
protected java.lang.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 ArgumentsMetadata Modifier and Type Method Description protected <T> void
HtmlCommandUsageGenerator. outputOptions(java.io.Writer writer, java.util.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 ArgumentsMetadata Modifier and Type Method Description <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 ArgumentsMetadata Modifier and Type Method Description <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, java.util.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 ArgumentsMetadata Modifier and Type Field Description private ArgumentsMetadata
CommandMetadata. arguments
Fields in com.github.rvesse.airline.model with type parameters of type ArgumentsMetadata Modifier and Type Field Description private java.util.List<ArgumentsMetadata>
MetadataLoader.InjectionMetadata. arguments
Methods in com.github.rvesse.airline.model that return ArgumentsMetadata Modifier and Type Method Description ArgumentsMetadata
CommandMetadata. getArguments()
Constructors in com.github.rvesse.airline.model with parameters of type ArgumentsMetadata Constructor Description CommandMetadata(java.lang.String name, java.lang.String description, boolean hidden, java.lang.Iterable<OptionMetadata> globalOptions, java.lang.Iterable<OptionMetadata> groupOptions, java.lang.Iterable<OptionMetadata> commandOptions, OptionMetadata defaultOption, ArgumentsMetadata arguments, java.lang.Iterable<Accessor> metadataInjections, java.lang.Class<?> type, java.util.List<java.lang.String> groupNames, java.util.List<Group> groups, java.util.List<HelpSection> sections)
Constructor parameters in com.github.rvesse.airline.model with type arguments of type ArgumentsMetadata Constructor Description ArgumentsMetadata(java.lang.Iterable<ArgumentsMetadata> arguments)
-
Uses of ArgumentsMetadata in com.github.rvesse.airline.parser
Methods in com.github.rvesse.airline.parser with parameters of type ArgumentsMetadata Modifier and Type Method Description static <T> T
ParserUtil. createInstance(java.lang.Class<?> type, java.lang.Iterable<OptionMetadata> options, java.util.List<org.apache.commons.lang3.tuple.Pair<OptionMetadata,java.lang.Object>> parsedOptions, ArgumentsMetadata arguments, java.lang.Iterable<java.lang.Object> parsedArguments, java.lang.Iterable<Accessor> metadataInjection, java.util.Map<java.lang.Class<?>,java.lang.Object> bindings)
static <T> T
ParserUtil. createInstance(java.lang.Class<?> type, java.lang.Iterable<OptionMetadata> options, java.util.List<org.apache.commons.lang3.tuple.Pair<OptionMetadata,java.lang.Object>> parsedOptions, ArgumentsMetadata arguments, java.lang.Iterable<java.lang.Object> parsedArguments, java.lang.Iterable<Accessor> metadataInjection, java.util.Map<java.lang.Class<?>,java.lang.Object> bindings, CommandFactory<T> commandFactory)
static <T> T
ParserUtil. injectOptions(T commandInstance, java.lang.Iterable<OptionMetadata> options, java.util.List<org.apache.commons.lang3.tuple.Pair<OptionMetadata,java.lang.Object>> parsedOptions, ArgumentsMetadata arguments, java.lang.Iterable<java.lang.Object> parsedArguments, java.lang.Iterable<Accessor> metadataInjection, java.util.Map<java.lang.Class<?>,java.lang.Object> bindings)
private ParseState<T>
AbstractCommandParser. parseArg(ParseState<T> state, org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ArgumentsMetadata arguments, OptionMetadata defaultOption)
private ParseState<T>
AbstractCommandParser. parseArgs(ParseState<T> state, org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ArgumentsMetadata arguments, OptionMetadata defaultOption)
ParseState<T>
ParseState. withArgument(ArgumentsMetadata arguments, java.lang.String rawValue)
-
Uses of ArgumentsMetadata in com.github.rvesse.airline.restrictions
Methods in com.github.rvesse.airline.restrictions with parameters of type ArgumentsMetadata Modifier and Type Method Description <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> java.lang.String
AbstractCommonRestriction. getArgumentTitle(ArgumentsMetadata arguments, int argIndex)
static <T> java.lang.String
AbstractCommonRestriction. getArgumentTitle(ParseState<T> state, ArgumentsMetadata arguments)
<T> void
AbstractCommonRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)
<T> void
ArgumentsRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.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, java.lang.String value)
<T> void
ArgumentsRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.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 ArgumentsMetadata Modifier and Type Method Description <T> void
IsRequiredRestriction. finalValidate(ParseState<T> state, ArgumentsMetadata arguments)
<T> void
OccurrencesRestriction. finalValidate(ParseState<T> state, ArgumentsMetadata arguments)
protected void
PortRestriction. invalidArgumentsPort(ArgumentsMetadata arguments, java.lang.String title, java.lang.Object value)
<T> void
AllowedValuesRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)
<T> void
PartialRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)
<T> void
PortRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)
<T> void
PositiveNegativeRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)
<T> void
RangeRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)
<T> void
AbstractStringRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
<T> void
AllowedEnumValuesRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
<T> void
AllowedRawValuesRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
<T> void
PartialRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
<T> void
PathRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
<T> void
PatternRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
private <T> java.util.List<java.lang.String>
OccurrencesRestriction. titles(ParseState<T> state, ArgumentsMetadata arguments)
protected abstract <T> ParseRestrictionViolatedException
AbstractStringRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.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, java.lang.String value)
protected <T> ParseRestrictionViolatedException
LengthRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
protected <T> ParseRestrictionViolatedException
NoOptionLikeValuesRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
protected <T> ParseRestrictionViolatedException
NotBlankRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
protected <T> ParseRestrictionViolatedException
NotEmptyRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
protected <T> ParseRestrictionViolatedException
StartsWithRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)
-
Uses of ArgumentsMetadata in com.github.rvesse.airline.restrictions.options
Methods in com.github.rvesse.airline.restrictions.options with parameters of type ArgumentsMetadata Modifier and Type Method Description <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 ArgumentsMetadata Modifier and Type Method Description <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 ArgumentsMetadata Modifier and Type Method Description <T> TypeConverter
DefaultNumericConverter. getTypeConverter(ArgumentsMetadata arguments, ParseState<T> state)
-