Modifier and Type | Field and Description |
---|---|
static Comparator<OptionMetadata> |
UsageHelper.DEFAULT_OPTION_COMPARATOR
Default comparator for options
|
Modifier and Type | Method and Description |
---|---|
protected List<OptionMetadata> |
CliCommandUsageGenerator.outputSynopsis(UsagePrinter out,
String programName,
String[] groupNames,
String commandName,
CommandMetadata command)
Outputs a documentation section with a synopsis of command usage
|
Modifier and Type | Method and Description |
---|---|
protected void |
CliUsageHelper.outputOptionRestriction(UsagePrinter out,
OptionMetadata option,
OptionRestriction restriction,
HelpHint hint)
Outputs documentation about a restriction on an option
|
Modifier and Type | Method and Description |
---|---|
protected CliUsageHelper |
CliGlobalUsageGenerator.createHelper(Comparator<? super OptionMetadata> optionComparator,
boolean includeHidden) |
protected CliUsageHelper |
CliCommandUsageGenerator.createHelper(Comparator<? super OptionMetadata> optionComparator,
boolean includeHidden) |
void |
CliUsageHelper.outputOptions(UsagePrinter out,
List<OptionMetadata> options) |
protected <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
|
Constructor and Description |
---|
CliCommandGroupUsageGenerator(int columns,
boolean hideGlobalOptions,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
boolean includeHidden) |
CliCommandUsageGenerator(int columns,
Comparator<? super OptionMetadata> optionComparator,
boolean includeHidden) |
CliGlobalUsageGenerator(int columnSize,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
CliGlobalUsageSummaryGenerator(int columnSize,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
CliUsageHelper(Comparator<? super OptionMetadata> optionComparator,
boolean includeHidden) |
Modifier and Type | Method and Description |
---|---|
protected Comparator<? super OptionMetadata> |
AbstractUsageGenerator.getOptionComparator() |
protected List<OptionMetadata> |
AbstractUsageGenerator.sortOptions(List<OptionMetadata> options)
Sorts the options assuming a non-null comparator was provided at
instantiation time
|
Modifier and Type | Method and Description |
---|---|
protected String |
AbstractUsageGenerator.toDescription(OptionMetadata option) |
protected String |
AbstractUsageGenerator.toUsage(OptionMetadata option) |
Modifier and Type | Method and Description |
---|---|
protected List<OptionMetadata> |
AbstractUsageGenerator.sortOptions(List<OptionMetadata> options)
Sorts the options assuming a non-null comparator was provided at
instantiation time
|
protected List<String> |
AbstractUsageGenerator.toSynopsisUsage(List<OptionMetadata> options)
Converts the options into their synopsis representation for the usage
documentation
|
Constructor and Description |
---|
AbstractCommandGroupUsageGenerator(Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
boolean includeHidden) |
AbstractCommandUsageGenerator(Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super Map.Entry<Integer,String>> exitCodeComparator,
boolean includeHidden) |
AbstractCommandUsageGenerator(Comparator<? super OptionMetadata> optionComparator) |
AbstractCommandUsageGenerator(Comparator<? super OptionMetadata> optionComparator,
boolean includeHidden) |
AbstractGlobalUsageGenerator(Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
AbstractPrintedCommandGroupUsageGenerator(int columnSize,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
boolean includeHidden) |
AbstractPrintedCommandUsageGenerator(int columns,
Comparator<? super OptionMetadata> optionComparator,
boolean includeHidden) |
AbstractPrintedGlobalUsageGenerator(int columns,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
AbstractUsageGenerator(Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
boolean includeHidden) |
Modifier and Type | Method and Description |
---|---|
OptionMetadata |
CommandMetadata.getDefaultOption() |
static OptionMetadata |
OptionMetadata.override(Set<String> names,
OptionMetadata parent,
OptionMetadata child)
Tries to merge the option metadata together such that the child metadata
takes precedence.
|
Modifier and Type | Method and Description |
---|---|
List<OptionMetadata> |
CommandMetadata.getAllOptions() |
List<OptionMetadata> |
CommandMetadata.getCommandOptions() |
List<OptionMetadata> |
CommandMetadata.getGlobalOptions() |
List<OptionMetadata> |
CommandMetadata.getGroupOptions() |
List<OptionMetadata> |
GlobalMetadata.getOptions() |
List<OptionMetadata> |
CommandGroupMetadata.getOptions()
Gets the group options
|
Modifier and Type | Method and Description |
---|---|
static OptionMetadata |
OptionMetadata.override(Set<String> names,
OptionMetadata parent,
OptionMetadata child)
Tries to merge the option metadata together such that the child metadata
takes precedence.
|
Constructor and Description |
---|
CommandMetadata(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 and Description |
---|
CommandGroupMetadata(String name,
String description,
boolean hidden,
Iterable<OptionMetadata> options,
Iterable<CommandGroupMetadata> subGroups,
CommandMetadata defaultCommand,
Iterable<CommandMetadata> commands) |
CommandMetadata(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) |
CommandMetadata(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) |
CommandMetadata(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) |
GlobalMetadata(String name,
String description,
Iterable<OptionMetadata> options,
CommandMetadata defaultCommand,
Iterable<CommandMetadata> defaultGroupCommands,
Iterable<CommandGroupMetadata> commandGroups,
Iterable<GlobalRestriction> restrictions,
ParserMetadata<T> parserConfig) |
OptionMetadata(Iterable<OptionMetadata> options) |
Modifier and Type | Method and Description |
---|---|
OptionMetadata |
ParseState.getCurrentOption() |
Modifier and Type | Method and Description |
---|---|
List<org.apache.commons.lang3.tuple.Pair<OptionMetadata,Object>> |
ParseState.getParsedOptions() |
Modifier and Type | Method and Description |
---|---|
ParseState<T> |
ParseState.withOption(OptionMetadata option) |
ParseState<T> |
ParseState.withOptionValue(OptionMetadata option,
String rawValue) |
Modifier and Type | Method and Description |
---|---|
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) |
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) |
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.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) |
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) |
Modifier and Type | Method and Description |
---|---|
Set<OptionMetadata> |
ParseOptionGroupException.getOptions() |
Constructor and Description |
---|
ParseOptionGroupException(String message,
String tag,
Collection<OptionMetadata> options,
Object... args) |
Modifier and Type | Method and Description |
---|---|
protected OptionMetadata |
AbstractOptionParser.findOption(ParseState<T> state,
List<OptionMetadata> options,
String name)
Tries to find an option with the given name
|
protected OptionMetadata |
AbstractOptionParser.findOption(ParseState<T> state,
List<OptionMetadata> options,
String name,
OptionMetadata defaultValue)
Tries to find an option with the given name
|
Modifier and Type | Method and Description |
---|---|
protected OptionMetadata |
AbstractOptionParser.findOption(ParseState<T> state,
List<OptionMetadata> options,
String name,
OptionMetadata defaultValue)
Tries to find an option with the given name
|
Modifier and Type | Method and Description |
---|---|
protected OptionMetadata |
AbstractOptionParser.findOption(ParseState<T> state,
List<OptionMetadata> options,
String name)
Tries to find an option with the given name
|
protected OptionMetadata |
AbstractOptionParser.findOption(ParseState<T> state,
List<OptionMetadata> options,
String name,
OptionMetadata defaultValue)
Tries to find an option with the given name
|
ParseState<T> |
StandardOptionParser.parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state,
List<OptionMetadata> allowedOptions) |
ParseState<T> |
OptionParser.parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state,
List<OptionMetadata> allowedOptions)
Parses one/more options from the token stream
|
ParseState<T> |
MaybePairValueOptionParser.parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state,
List<OptionMetadata> allowedOptions) |
ParseState<T> |
ListValueOptionParser.parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state,
List<OptionMetadata> allowedOptions) |
ParseState<T> |
ClassicGetOptParser.parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state,
List<OptionMetadata> allowedOptions) |
ParseState<T> |
AbstractNameValueOptionParser.parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state,
List<OptionMetadata> allowedOptions) |
Modifier and Type | Method and Description |
---|---|
<T> void |
OptionRestriction.finalValidate(ParseState<T> state,
OptionMetadata option)
Method that is called after Airline has completed parsing
|
<T> void |
AbstractCommonRestriction.finalValidate(ParseState<T> state,
OptionMetadata option) |
<T> void |
OptionRestriction.postValidate(ParseState<T> state,
OptionMetadata option,
Object value)
Method that is called after Airline has converted a string argument
received into a strongly typed Java value
|
<T> void |
AbstractCommonRestriction.postValidate(ParseState<T> state,
OptionMetadata option,
Object value) |
<T> void |
OptionRestriction.preValidate(ParseState<T> state,
OptionMetadata option,
String value)
Method that is called before Airline attempts to convert a string
argument received into a strongly typed Java value
|
<T> void |
AbstractCommonRestriction.preValidate(ParseState<T> state,
OptionMetadata option,
String value) |
Modifier and Type | Method and Description |
---|---|
<T> void |
OccurrencesRestriction.finalValidate(ParseState<T> state,
OptionMetadata option) |
<T> void |
IsRequiredRestriction.finalValidate(ParseState<T> state,
OptionMetadata option) |
protected void |
PortRestriction.invalidOptionPort(OptionMetadata option,
Object value) |
<T> void |
RangeRestriction.postValidate(ParseState<T> state,
OptionMetadata option,
Object value) |
<T> void |
PortRestriction.postValidate(ParseState<T> state,
OptionMetadata option,
Object value) |
<T> void |
PartialRestriction.postValidate(ParseState<T> state,
OptionMetadata option,
Object value) |
<T> void |
AllowedValuesRestriction.postValidate(ParseState<T> state,
OptionMetadata option,
Object value) |
<T> void |
PatternRestriction.preValidate(ParseState<T> state,
OptionMetadata option,
String value) |
<T> void |
PathRestriction.preValidate(ParseState<T> state,
OptionMetadata option,
String value) |
<T> void |
PartialRestriction.preValidate(ParseState<T> state,
OptionMetadata option,
String value) |
<T> void |
AllowedRawValuesRestriction.preValidate(ParseState<T> state,
OptionMetadata option,
String value) |
<T> void |
AbstractStringRestriction.preValidate(ParseState<T> state,
OptionMetadata option,
String value) |
protected <T> ParseRestrictionViolatedException |
NotEmptyRestriction.violated(ParseState<T> state,
OptionMetadata option,
String value) |
protected <T> ParseRestrictionViolatedException |
NotBlankRestriction.violated(ParseState<T> state,
OptionMetadata option,
String value) |
protected <T> ParseRestrictionViolatedException |
LengthRestriction.violated(ParseState<T> state,
OptionMetadata option,
String value) |
protected abstract <T> ParseRestrictionViolatedException |
AbstractStringRestriction.violated(ParseState<T> state,
OptionMetadata option,
String value)
Method that derived classes must implement to provide an exception for
the case of an invalid option value, this will be called if
AbstractStringRestriction.isValid(String) returns false |
Modifier and Type | Method and Description |
---|---|
<T> void |
RequireFromRestriction.finalValidate(ParseState<T> state,
OptionMetadata option) |
<T> void |
RequiredOnlyIfRestriction.finalValidate(ParseState<T> state,
OptionMetadata option) |
<T> void |
MutuallyExclusiveRestriction.finalValidate(ParseState<T> state,
OptionMetadata option) |
<T> void |
RequireFromRestriction.postValidate(ParseState<T> state,
OptionMetadata option,
Object value) |
<T> void |
RequiredOnlyIfRestriction.postValidate(ParseState<T> state,
OptionMetadata option,
Object value) |
<T> void |
MutuallyExclusiveRestriction.postValidate(ParseState<T> state,
OptionMetadata option,
Object value) |
<T> void |
RequireFromRestriction.preValidate(ParseState<T> state,
OptionMetadata option,
String value) |
<T> void |
RequiredOnlyIfRestriction.preValidate(ParseState<T> state,
OptionMetadata option,
String value) |
<T> void |
MutuallyExclusiveRestriction.preValidate(ParseState<T> state,
OptionMetadata option,
String value) |
Modifier and Type | Method and Description |
---|---|
<T> TypeConverter |
TypeConverterProvider.getTypeConverter(OptionMetadata option,
ParseState<T> state)
Gets the type converter to use for the given option and parser state
|
<T> TypeConverter |
DefaultTypeConverterProvider.getTypeConverter(OptionMetadata option,
ParseState<T> state) |
Modifier and Type | Method and Description |
---|---|
<T> TypeConverter |
DefaultNumericConverter.getTypeConverter(OptionMetadata option,
ParseState<T> state) |
Modifier and Type | Method and Description |
---|---|
boolean |
OptionFinder.evaluate(OptionMetadata option) |
protected boolean |
AbbreviatedOptionFinder.isExactNameMatch(String value,
OptionMetadata item) |
protected boolean |
AbbreviatedOptionFinder.isPartialNameMatch(String value,
OptionMetadata item) |
Modifier and Type | Method and Description |
---|---|
boolean |
ParsedOptionFinder.evaluate(org.apache.commons.lang3.tuple.Pair<OptionMetadata,Object> parsedOption) |
Constructor and Description |
---|
ParsedOptionFinder(OptionMetadata option) |
Constructor and Description |
---|
AbbreviatedOptionFinder(String value,
Collection<OptionMetadata> items) |
Modifier and Type | Method and Description |
---|---|
boolean |
AbstractOptionRestrictionBasedFinder.evaluate(OptionMetadata arg0) |
Modifier and Type | Method and Description |
---|---|
boolean |
AbstractParsedOptionRestrictionBasedFinder.evaluate(org.apache.commons.lang3.tuple.Pair<OptionMetadata,Object> parsedOption) |
Copyright © 2012–2017. All rights reserved.