Uses of Class
com.github.rvesse.airline.model.OptionMetadata
-
-
Uses of OptionMetadata in com.github.rvesse.airline.examples.userguide.parser.options
Method parameters in com.github.rvesse.airline.examples.userguide.parser.options with type arguments of type OptionMetadata Modifier and Type Method Description ParseState<T>
JdbcStyleOptionParser. parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, java.util.List<OptionMetadata> allowedOptions)
-
Uses of OptionMetadata in com.github.rvesse.airline.examples.userguide.restrictions.custom
Methods in com.github.rvesse.airline.examples.userguide.restrictions.custom with parameters of type OptionMetadata Modifier and Type Method Description <T> void
MultipleOfRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)
-
Uses of OptionMetadata in com.github.rvesse.airline.help
Fields in com.github.rvesse.airline.help with type parameters of type OptionMetadata Modifier and Type Field Description static java.util.Comparator<OptionMetadata>
UsageHelper. DEFAULT_OPTION_COMPARATOR
Default comparator for options -
Uses of OptionMetadata in com.github.rvesse.airline.help.cli
Methods in com.github.rvesse.airline.help.cli that return types with arguments of type OptionMetadata Modifier and Type Method Description protected java.util.List<OptionMetadata>
CliCommandUsageGenerator. outputSynopsis(UsagePrinter out, java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command)
Outputs a documentation section with a synopsis of command usageMethods in com.github.rvesse.airline.help.cli with parameters of type OptionMetadata Modifier and Type Method Description protected void
CliUsageHelper. outputOptionRestriction(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint)
Outputs documentation about a restriction on an optionMethod parameters in com.github.rvesse.airline.help.cli with type arguments of type OptionMetadata Modifier and Type Method Description protected CliUsageHelper
CliCommandUsageGenerator. createHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
protected CliUsageHelper
CliGlobalUsageGenerator. createHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
protected CliUsageHelper
CliGlobalUsageSummaryGenerator. createHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
void
CliUsageHelper. outputOptions(UsagePrinter out, java.util.List<OptionMetadata> options)
protected <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 usagesConstructor parameters in com.github.rvesse.airline.help.cli with type arguments of type OptionMetadata Constructor Description CliCommandUsageGenerator(int columns, java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
CliUsageHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
-
Uses of OptionMetadata in com.github.rvesse.airline.help.cli.bash
Methods in com.github.rvesse.airline.help.cli.bash with parameters of type OptionMetadata Modifier and Type Method Description protected BashCompletion
BashCompletionGenerator. getCompletionData(OptionMetadata option)
Gets the completion info for an option -
Uses of OptionMetadata in com.github.rvesse.airline.help.common
Fields in com.github.rvesse.airline.help.common with type parameters of type OptionMetadata Modifier and Type Field Description private java.util.Comparator<? super OptionMetadata>
AbstractUsageGenerator. optionComparator
Methods in com.github.rvesse.airline.help.common that return types with arguments of type OptionMetadata Modifier and Type Method Description protected java.util.Comparator<? super OptionMetadata>
AbstractUsageGenerator. getOptionComparator()
protected java.util.List<OptionMetadata>
AbstractUsageGenerator. sortOptions(java.util.List<OptionMetadata> options)
Sorts the options assuming a non-null comparator was provided at instantiation timeMethods in com.github.rvesse.airline.help.common with parameters of type OptionMetadata Modifier and Type Method Description protected java.lang.String
AbstractUsageGenerator. toDescription(OptionMetadata option)
protected java.lang.String
AbstractUsageGenerator. toUsage(OptionMetadata option)
Method parameters in com.github.rvesse.airline.help.common with type arguments of type OptionMetadata Modifier and Type Method Description protected java.util.List<OptionMetadata>
AbstractUsageGenerator. sortOptions(java.util.List<OptionMetadata> options)
Sorts the options assuming a non-null comparator was provided at instantiation timeprotected java.util.List<java.lang.String>
AbstractUsageGenerator. toSynopsisUsage(java.util.List<OptionMetadata> options)
Converts the options into their synopsis representation for the usage documentationConstructor parameters in com.github.rvesse.airline.help.common with type arguments of type OptionMetadata Constructor Description AbstractCommandUsageGenerator(java.util.Comparator<? super OptionMetadata> optionComparator)
AbstractCommandUsageGenerator(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
AbstractPrintedCommandUsageGenerator(int columns, java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
-
Uses of OptionMetadata in com.github.rvesse.airline.help.html
Methods in com.github.rvesse.airline.help.html that return types with arguments of type OptionMetadata Modifier and Type Method Description protected java.util.List<OptionMetadata>
HtmlCommandUsageGenerator. outputSynopsis(java.io.Writer writer, java.lang.String programName, java.lang.String[] groupNames, CommandMetadata command)
Outputs a documentation section with a synopsis of the commandMethods in com.github.rvesse.airline.help.html with parameters of type OptionMetadata Modifier and Type Method Description protected void
HtmlCommandUsageGenerator. outputOptionRestriction(java.io.Writer writer, OptionMetadata option, OptionRestriction restriction, HelpHint hint)
Outputs a documentation section detailing an allowed value for an optionMethod parameters in com.github.rvesse.airline.help.html with type arguments of type OptionMetadata 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 optionsConstructor parameters in com.github.rvesse.airline.help.html with type arguments of type OptionMetadata Constructor Description HtmlCommandUsageGenerator(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden, java.lang.String... stylesheetUrls)
-
Uses of OptionMetadata in com.github.rvesse.airline.help.man
Methods in com.github.rvesse.airline.help.man that return types with arguments of type OptionMetadata Modifier and Type Method Description protected java.util.List<OptionMetadata>
ManCommandUsageGenerator. outputSynopsis(TroffPrinter printer, java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command)
Outputs a synopsis section for the documentation showing how to use a commandMethods in com.github.rvesse.airline.help.man with parameters of type OptionMetadata Modifier and Type Method Description protected void
ManUsageHelper. outputOptionRestriction(TroffPrinter printer, OptionMetadata option, OptionRestriction restriction, HelpHint hint)
Outputs documentation about a restriction on an optionvoid
ManUsageHelper. outputOptionSynopsis(TroffPrinter printer, OptionMetadata option)
void
ManUsageHelper. outputOptionTitle(TroffPrinter printer, OptionMetadata option)
protected java.lang.String
ManCommandUsageGenerator. toDescription(OptionMetadata option)
protected java.lang.String
ManGlobalUsageGenerator. toDescription(OptionMetadata option)
Converts an option to its description formMethod parameters in com.github.rvesse.airline.help.man with type arguments of type OptionMetadata Modifier and Type Method Description protected <T> void
ManCommandUsageGenerator. outputOptions(TroffPrinter printer, CommandMetadata command, java.util.List<OptionMetadata> options, ParserMetadata<T> parserConfig)
Outputs a documentation section detailing the options and their usagesint
ManUsageHelper. outputOptions(TroffPrinter printer, java.util.List<OptionMetadata> options, boolean endList)
void
ManUsageHelper. outputOptionsSynopsis(TroffPrinter printer, java.util.List<OptionMetadata> options)
Constructor parameters in com.github.rvesse.airline.help.man with type arguments of type OptionMetadata Constructor Description ManUsageHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
-
Uses of OptionMetadata in com.github.rvesse.airline.help.markdown
Methods in com.github.rvesse.airline.help.markdown that return types with arguments of type OptionMetadata Modifier and Type Method Description protected java.util.List<OptionMetadata>
MarkdownCommandUsageGenerator. outputSynopsis(UsagePrinter out, java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command)
Outputs a documentation section with a synopsis of command usageMethods in com.github.rvesse.airline.help.markdown with parameters of type OptionMetadata Modifier and Type Method Description protected void
MarkdownUsageHelper. outputOptionRestriction(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint)
Outputs documentation about a restriction on an optionvoid
MarkdownUsageHelper. outputOptionSynopsis(UsagePrinter printer, OptionMetadata option)
void
MarkdownUsageHelper. outputOptionTitle(UsagePrinter printer, OptionMetadata option)
Method parameters in com.github.rvesse.airline.help.markdown with type arguments of type OptionMetadata Modifier and Type Method Description protected MarkdownUsageHelper
MarkdownCommandUsageGenerator. createHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
protected MarkdownUsageHelper
MarkdownGlobalUsageGenerator. createHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
void
MarkdownUsageHelper. outputOptions(UsagePrinter out, java.util.List<OptionMetadata> options)
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 usagesvoid
MarkdownUsageHelper. outputOptionsSynopsis(UsagePrinter printer, java.util.List<OptionMetadata> options)
Constructor parameters in com.github.rvesse.airline.help.markdown with type arguments of type OptionMetadata Constructor Description MarkdownCommandUsageGenerator(int columns, java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
MarkdownUsageHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
-
Uses of OptionMetadata in com.github.rvesse.airline.model
Fields in com.github.rvesse.airline.model declared as OptionMetadata Modifier and Type Field Description private OptionMetadata
CommandMetadata. defaultOption
private OptionMetadata
MetadataLoader.InjectionMetadata. defaultOption
Fields in com.github.rvesse.airline.model with type parameters of type OptionMetadata Modifier and Type Field Description private java.util.List<OptionMetadata>
CommandMetadata. commandOptions
private java.util.List<OptionMetadata>
MetadataLoader.InjectionMetadata. commandOptions
private java.util.List<OptionMetadata>
CommandMetadata. globalOptions
private java.util.List<OptionMetadata>
MetadataLoader.InjectionMetadata. globalOptions
private java.util.List<OptionMetadata>
CommandMetadata. groupOptions
private java.util.List<OptionMetadata>
MetadataLoader.InjectionMetadata. groupOptions
private java.util.List<OptionMetadata>
CommandGroupMetadata. options
private java.util.List<OptionMetadata>
GlobalMetadata. options
Methods in com.github.rvesse.airline.model that return OptionMetadata Modifier and Type Method Description OptionMetadata
CommandMetadata. getDefaultOption()
static OptionMetadata
OptionMetadata. override(java.util.Set<java.lang.String> names, OptionMetadata parent, OptionMetadata child)
Tries to merge the option metadata together such that the child metadata takes precedence.Methods in com.github.rvesse.airline.model that return types with arguments of type OptionMetadata Modifier and Type Method Description java.util.List<OptionMetadata>
CommandMetadata. getAllOptions()
java.util.List<OptionMetadata>
CommandMetadata. getCommandOptions()
java.util.List<OptionMetadata>
CommandMetadata. getGlobalOptions()
java.util.List<OptionMetadata>
CommandMetadata. getGroupOptions()
java.util.List<OptionMetadata>
CommandGroupMetadata. getOptions()
Gets the group optionsjava.util.List<OptionMetadata>
GlobalMetadata. getOptions()
Gets the global scoped optionsprivate static java.util.List<OptionMetadata>
MetadataLoader. mergeOptionSet(java.util.List<OptionMetadata> options)
private static java.util.List<OptionMetadata>
MetadataLoader. overrideOptionSet(java.util.List<OptionMetadata> options)
Methods in com.github.rvesse.airline.model with parameters of type OptionMetadata Modifier and Type Method Description static OptionMetadata
OptionMetadata. override(java.util.Set<java.lang.String> names, OptionMetadata parent, OptionMetadata child)
Tries to merge the option metadata together such that the child metadata takes precedence.private static void
MetadataLoader. tryOverrideOptions(java.util.Map<java.util.Set<java.lang.String>,OptionMetadata> optionIndex, java.util.Set<java.lang.String> names, OptionMetadata parent)
Method parameters in com.github.rvesse.airline.model with type arguments of type OptionMetadata Modifier and Type Method Description private static java.util.List<OptionMetadata>
MetadataLoader. mergeOptionSet(java.util.List<OptionMetadata> options)
private static java.util.List<OptionMetadata>
MetadataLoader. overrideOptionSet(java.util.List<OptionMetadata> options)
private static void
MetadataLoader. tryOverrideOptions(java.util.Map<java.util.Set<java.lang.String>,OptionMetadata> optionIndex, java.util.Set<java.lang.String> names, OptionMetadata parent)
Constructors in com.github.rvesse.airline.model with parameters of type OptionMetadata 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 OptionMetadata Constructor Description CommandGroupMetadata(java.lang.String name, java.lang.String description, boolean hidden, java.lang.Iterable<OptionMetadata> options, java.lang.Iterable<CommandGroupMetadata> subGroups, CommandMetadata defaultCommand, java.lang.Iterable<CommandMetadata> commands)
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)
GlobalMetadata(java.lang.String name, java.lang.String description, java.lang.Iterable<OptionMetadata> options, CommandMetadata defaultCommand, java.lang.Iterable<CommandMetadata> defaultGroupCommands, java.lang.Iterable<CommandGroupMetadata> commandGroups, java.lang.Iterable<GlobalRestriction> restrictions, java.lang.Iterable<HelpSection> baseHelpSections, ParserMetadata<T> parserConfig)
OptionMetadata(java.lang.Iterable<OptionMetadata> options)
-
Uses of OptionMetadata in com.github.rvesse.airline.parser
Fields in com.github.rvesse.airline.parser declared as OptionMetadata Modifier and Type Field Description private OptionMetadata
ParseState. currentOption
Fields in com.github.rvesse.airline.parser with type parameters of type OptionMetadata Modifier and Type Field Description private java.util.Map<OptionMetadata,java.lang.Integer>
ParseState. optionsCount
private java.util.List<org.apache.commons.lang3.tuple.Pair<OptionMetadata,java.lang.Object>>
ParseState. parsedOptions
Methods in com.github.rvesse.airline.parser that return OptionMetadata Modifier and Type Method Description OptionMetadata
ParseState. getCurrentOption()
Methods in com.github.rvesse.airline.parser that return types with arguments of type OptionMetadata Modifier and Type Method Description java.util.List<org.apache.commons.lang3.tuple.Pair<OptionMetadata,java.lang.Object>>
ParseState. getParsedOptions()
Methods in com.github.rvesse.airline.parser with parameters of type OptionMetadata Modifier and Type Method Description int
ParseState. getOptionValuesSeen(OptionMetadata option)
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. withOption(OptionMetadata option)
ParseState<T>
ParseState. withOptionValue(OptionMetadata option, java.lang.String rawValue)
Method parameters in com.github.rvesse.airline.parser with type arguments of type OptionMetadata 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)
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. 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)
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. parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, java.util.List<OptionMetadata> allowedOptions)
Constructors in com.github.rvesse.airline.parser with parameters of type OptionMetadata Constructor Description ParseState(GlobalMetadata<T> global, ParserMetadata<T> parserConfig, CommandGroupMetadata group, CommandMetadata command, java.util.List<org.apache.commons.lang3.tuple.Pair<OptionMetadata,java.lang.Object>> parsedOptions, java.util.Map<OptionMetadata,java.lang.Integer> optionsCount, java.util.List<Context> locationStack, java.util.List<java.lang.Object> parsedArguments, OptionMetadata currentOption, java.util.List<java.lang.String> unparsedInput)
Constructor parameters in com.github.rvesse.airline.parser with type arguments of type OptionMetadata Constructor Description ParseState(GlobalMetadata<T> global, ParserMetadata<T> parserConfig, CommandGroupMetadata group, CommandMetadata command, java.util.List<org.apache.commons.lang3.tuple.Pair<OptionMetadata,java.lang.Object>> parsedOptions, java.util.Map<OptionMetadata,java.lang.Integer> optionsCount, java.util.List<Context> locationStack, java.util.List<java.lang.Object> parsedArguments, OptionMetadata currentOption, java.util.List<java.lang.String> unparsedInput)
ParseState(GlobalMetadata<T> global, ParserMetadata<T> parserConfig, CommandGroupMetadata group, CommandMetadata command, java.util.List<org.apache.commons.lang3.tuple.Pair<OptionMetadata,java.lang.Object>> parsedOptions, java.util.Map<OptionMetadata,java.lang.Integer> optionsCount, java.util.List<Context> locationStack, java.util.List<java.lang.Object> parsedArguments, OptionMetadata currentOption, java.util.List<java.lang.String> unparsedInput)
-
Uses of OptionMetadata in com.github.rvesse.airline.parser.errors
Fields in com.github.rvesse.airline.parser.errors with type parameters of type OptionMetadata Modifier and Type Field Description private java.util.Set<OptionMetadata>
ParseOptionGroupException. options
Methods in com.github.rvesse.airline.parser.errors that return types with arguments of type OptionMetadata Modifier and Type Method Description java.util.Set<OptionMetadata>
ParseOptionGroupException. getOptions()
Constructor parameters in com.github.rvesse.airline.parser.errors with type arguments of type OptionMetadata Constructor Description ParseOptionGroupException(java.lang.String message, java.lang.String tag, java.util.Collection<OptionMetadata> options, java.lang.Object... args)
-
Uses of OptionMetadata in com.github.rvesse.airline.parser.options
Methods in com.github.rvesse.airline.parser.options that return OptionMetadata Modifier and Type Method Description protected OptionMetadata
AbstractOptionParser. findOption(ParseState<T> state, java.util.List<OptionMetadata> options, java.lang.String name)
Tries to find an option with the given nameprotected OptionMetadata
AbstractOptionParser. findOption(ParseState<T> state, java.util.List<OptionMetadata> options, java.lang.String name, OptionMetadata defaultValue)
Tries to find an option with the given nameMethods in com.github.rvesse.airline.parser.options with parameters of type OptionMetadata Modifier and Type Method Description protected OptionMetadata
AbstractOptionParser. findOption(ParseState<T> state, java.util.List<OptionMetadata> options, java.lang.String name, OptionMetadata defaultValue)
Tries to find an option with the given nameprotected void
AbstractOptionParser. noValueForOption(ParseState<T> state, OptionMetadata option)
Reports that no/insufficient values were provided for an optionMethod parameters in com.github.rvesse.airline.parser.options with type arguments of type OptionMetadata Modifier and Type Method Description protected OptionMetadata
AbstractOptionParser. findOption(ParseState<T> state, java.util.List<OptionMetadata> options, java.lang.String name)
Tries to find an option with the given nameprotected OptionMetadata
AbstractOptionParser. findOption(ParseState<T> state, java.util.List<OptionMetadata> options, java.lang.String name, OptionMetadata defaultValue)
Tries to find an option with the given nameprotected boolean
AbstractOptionParser. isSeparatorOrOption(ParseState<T> state, java.util.List<OptionMetadata> allowedOptions, java.lang.String argsSeparator, boolean shortForm, java.lang.String peekedToken)
Checks whether the next value is an arguments separator or optionprotected boolean
GreedyClassicGetOptParser. isSeparatorOrOption(ParseState<T> state, java.util.List<OptionMetadata> allowedOptions, java.lang.String argsSeparator, boolean shortForm, java.lang.String peekedToken)
ParseState<T>
AbstractNameValueOptionParser. parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, java.util.List<OptionMetadata> allowedOptions)
ParseState<T>
ClassicGetOptParser. parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, java.util.List<OptionMetadata> allowedOptions)
ParseState<T>
ListValueOptionParser. parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, java.util.List<OptionMetadata> allowedOptions)
ParseState<T>
MaybeListValueOptionParser. parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, java.util.List<OptionMetadata> allowedOptions)
ParseState<T>
MaybePairValueOptionParser. parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, java.util.List<OptionMetadata> allowedOptions)
ParseState<T>
OptionParser. parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, java.util.List<OptionMetadata> allowedOptions)
Parses one/more options from the token streamParseState<T>
StandardOptionParser. parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, java.util.List<OptionMetadata> allowedOptions)
-
Uses of OptionMetadata in com.github.rvesse.airline.restrictions
Methods in com.github.rvesse.airline.restrictions with parameters of type OptionMetadata Modifier and Type Method Description <T> void
AbstractCommonRestriction. finalValidate(ParseState<T> state, OptionMetadata option)
<T> void
OptionRestriction. finalValidate(ParseState<T> state, OptionMetadata option)
Method that is called after Airline has completed parsingstatic <T> java.lang.String
AbstractCommonRestriction. getOptionTitle(ParseState<T> state, OptionMetadata option)
<T> void
AbstractCommonRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)
<T> void
OptionRestriction. postValidate(ParseState<T> state, OptionMetadata option, 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, OptionMetadata option, java.lang.String value)
<T> void
OptionRestriction. preValidate(ParseState<T> state, OptionMetadata option, 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 OptionMetadata in com.github.rvesse.airline.restrictions.common
Methods in com.github.rvesse.airline.restrictions.common with parameters of type OptionMetadata Modifier and Type Method Description <T> void
IsRequiredRestriction. finalValidate(ParseState<T> state, OptionMetadata option)
<T> void
OccurrencesRestriction. finalValidate(ParseState<T> state, OptionMetadata option)
protected void
PortRestriction. invalidOptionPort(OptionMetadata option, java.lang.String title, java.lang.Object value)
private <T> boolean
PartialRestriction. isApplicableToOption(ParseState<T> state, OptionMetadata option)
<T> void
AllowedValuesRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)
<T> void
PartialRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)
<T> void
PortRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)
<T> void
PositiveNegativeRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)
<T> void
RangeRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)
<T> void
AbstractStringRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)
<T> void
AllowedEnumValuesRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)
<T> void
AllowedRawValuesRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)
<T> void
PartialRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)
<T> void
PathRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)
<T> void
PatternRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)
protected abstract <T> ParseRestrictionViolatedException
AbstractStringRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value)
Method that derived classes must implement to provide an exception for the case of an invalid option value, this will be called ifAbstractStringRestriction.isValid(String)
returnsfalse
protected <T> ParseRestrictionViolatedException
EndsWithRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value)
protected <T> ParseRestrictionViolatedException
LengthRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value)
protected <T> ParseRestrictionViolatedException
NoOptionLikeValuesRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value)
protected <T> ParseRestrictionViolatedException
NotBlankRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value)
protected <T> ParseRestrictionViolatedException
NotEmptyRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value)
protected <T> ParseRestrictionViolatedException
StartsWithRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value)
-
Uses of OptionMetadata in com.github.rvesse.airline.restrictions.options
Methods in com.github.rvesse.airline.restrictions.options that return types with arguments of type OptionMetadata Modifier and Type Method Description private <T> java.util.Collection<OptionMetadata>
MutuallyExclusiveRestriction. getTaggedOptions(ParseState<T> state)
private <T> java.util.Collection<OptionMetadata>
RequireFromRestriction. getTaggedOptions(ParseState<T> state)
Methods in com.github.rvesse.airline.restrictions.options with parameters of type OptionMetadata Modifier and Type Method Description <T> void
AbstractRequiredUnlessRestriction. finalValidate(ParseState<T> state, OptionMetadata option)
<T> void
MutuallyExclusiveRestriction. finalValidate(ParseState<T> state, OptionMetadata option)
<T> void
RequiredOnlyIfRestriction. finalValidate(ParseState<T> state, OptionMetadata option)
<T> void
RequireFromRestriction. finalValidate(ParseState<T> state, OptionMetadata option)
<T> void
MutuallyExclusiveRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)
<T> void
RequiredOnlyIfRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)
<T> void
RequireFromRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)
<T> void
MutuallyExclusiveRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)
<T> void
RequiredOnlyIfRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)
<T> void
RequireFromRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)
protected abstract <T> boolean
AbstractRequiredUnlessRestriction. unless(ParseState<T> state, OptionMetadata option)
Answers whether the unless condition of the restriction is metprotected <T> boolean
RequiredUnlessEnvironmentRestriction. unless(ParseState<T> state, OptionMetadata option)
Method parameters in com.github.rvesse.airline.restrictions.options with type arguments of type OptionMetadata Modifier and Type Method Description private static java.lang.String
MutuallyExclusiveRestriction. toOptionsList(java.lang.Iterable<OptionMetadata> options)
private static java.lang.String
RequireFromRestriction. toOptionsList(java.lang.Iterable<OptionMetadata> options)
-
Uses of OptionMetadata in com.github.rvesse.airline.types
Methods in com.github.rvesse.airline.types with parameters of type OptionMetadata Modifier and Type Method Description <T> TypeConverter
DefaultTypeConverterProvider. getTypeConverter(OptionMetadata option, ParseState<T> state)
<T> TypeConverter
TypeConverterProvider. getTypeConverter(OptionMetadata option, ParseState<T> state)
Gets the type converter to use for the given option and parser state -
Uses of OptionMetadata in com.github.rvesse.airline.types.numerics
Methods in com.github.rvesse.airline.types.numerics with parameters of type OptionMetadata Modifier and Type Method Description <T> TypeConverter
DefaultNumericConverter. getTypeConverter(OptionMetadata option, ParseState<T> state)
-
Uses of OptionMetadata in com.github.rvesse.airline.utils.predicates.parser
Fields in com.github.rvesse.airline.utils.predicates.parser declared as OptionMetadata Modifier and Type Field Description private OptionMetadata
ParsedOptionFinder. opt
Methods in com.github.rvesse.airline.utils.predicates.parser with parameters of type OptionMetadata Modifier and Type Method Description boolean
OptionFinder. evaluate(OptionMetadata option)
protected boolean
AbbreviatedOptionFinder. isExactNameMatch(java.lang.String value, OptionMetadata item)
protected boolean
AbbreviatedOptionFinder. isPartialNameMatch(java.lang.String value, OptionMetadata item)
Method parameters in com.github.rvesse.airline.utils.predicates.parser with type arguments of type OptionMetadata Modifier and Type Method Description boolean
ParsedOptionFinder. evaluate(org.apache.commons.lang3.tuple.Pair<OptionMetadata,java.lang.Object> parsedOption)
Constructors in com.github.rvesse.airline.utils.predicates.parser with parameters of type OptionMetadata Constructor Description ParsedOptionFinder(OptionMetadata option)
Constructor parameters in com.github.rvesse.airline.utils.predicates.parser with type arguments of type OptionMetadata Constructor Description AbbreviatedOptionFinder(java.lang.String value, java.util.Collection<OptionMetadata> items)
-
Uses of OptionMetadata in com.github.rvesse.airline.utils.predicates.restrictions
Methods in com.github.rvesse.airline.utils.predicates.restrictions with parameters of type OptionMetadata Modifier and Type Method Description boolean
AbstractOptionRestrictionBasedFinder. evaluate(OptionMetadata arg0)
Method parameters in com.github.rvesse.airline.utils.predicates.restrictions with type arguments of type OptionMetadata Modifier and Type Method Description boolean
AbstractParsedOptionRestrictionBasedFinder. evaluate(org.apache.commons.lang3.tuple.Pair<OptionMetadata,java.lang.Object> parsedOption)
-