Modifier and Type | Method and 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 option
|
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
|
Modifier and Type | Method and Description |
---|---|
protected String |
AbstractUsageGenerator.toDescription(ArgumentsMetadata arguments) |
protected String |
AbstractUsageGenerator.toUsage(ArgumentsMetadata arguments) |
Modifier and Type | Method and Description |
---|---|
ArgumentsMetadata |
CommandMetadata.getArguments() |
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 |
---|
ArgumentsMetadata(Iterable<ArgumentsMetadata> arguments) |
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,
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) |
ParseState<T> |
ParseState.withArgument(ArgumentsMetadata arguments,
String rawValue) |
Modifier and Type | Method and Description |
---|---|
<T> void |
ArgumentsRestriction.finalValidate(ParseState<T> state,
ArgumentsMetadata arguments)
Method that is called after Airline has completed parsing
|
<T> void |
AbstractCommonRestriction.finalValidate(ParseState<T> state,
ArgumentsMetadata arguments) |
static <T> String |
AbstractCommonRestriction.getArgumentTitle(ArgumentsMetadata arguments,
int argIndex) |
static <T> String |
AbstractCommonRestriction.getArgumentTitle(ParseState<T> state,
ArgumentsMetadata arguments) |
<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.postValidate(ParseState<T> state,
ArgumentsMetadata arguments,
Object 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
|
<T> void |
AbstractCommonRestriction.preValidate(ParseState<T> state,
ArgumentsMetadata arguments,
String value) |
Modifier and Type | Method and Description |
---|---|
<T> void |
OccurrencesRestriction.finalValidate(ParseState<T> state,
ArgumentsMetadata arguments) |
<T> void |
IsRequiredRestriction.finalValidate(ParseState<T> state,
ArgumentsMetadata arguments) |
protected void |
PortRestriction.invalidArgumentsPort(ArgumentsMetadata arguments,
String title,
Object value) |
<T> void |
RangeRestriction.postValidate(ParseState<T> state,
ArgumentsMetadata arguments,
Object value) |
<T> void |
PortRestriction.postValidate(ParseState<T> state,
ArgumentsMetadata arguments,
Object value) |
<T> void |
PartialRestriction.postValidate(ParseState<T> state,
ArgumentsMetadata arguments,
Object value) |
<T> void |
AllowedValuesRestriction.postValidate(ParseState<T> state,
ArgumentsMetadata arguments,
Object value) |
<T> void |
PatternRestriction.preValidate(ParseState<T> state,
ArgumentsMetadata arguments,
String value) |
<T> void |
PathRestriction.preValidate(ParseState<T> state,
ArgumentsMetadata arguments,
String value) |
<T> void |
PartialRestriction.preValidate(ParseState<T> state,
ArgumentsMetadata arguments,
String value) |
<T> void |
AllowedRawValuesRestriction.preValidate(ParseState<T> state,
ArgumentsMetadata arguments,
String value) |
<T> void |
AbstractStringRestriction.preValidate(ParseState<T> state,
ArgumentsMetadata arguments,
String value) |
protected <T> ParseRestrictionViolatedException |
NotEmptyRestriction.violated(ParseState<T> state,
ArgumentsMetadata arguments,
String value) |
protected <T> ParseRestrictionViolatedException |
NotBlankRestriction.violated(ParseState<T> state,
ArgumentsMetadata arguments,
String value) |
protected <T> ParseRestrictionViolatedException |
LengthRestriction.violated(ParseState<T> state,
ArgumentsMetadata arguments,
String value) |
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 if
AbstractStringRestriction.isValid(String) returns false |
Modifier and Type | Method and Description |
---|---|
<T> TypeConverter |
TypeConverterProvider.getTypeConverter(ArgumentsMetadata arguments,
ParseState<T> state)
Gets the type converter to use for the given arguments and parser state
|
<T> TypeConverter |
DefaultTypeConverterProvider.getTypeConverter(ArgumentsMetadata arguments,
ParseState<T> state) |
Modifier and Type | Method and Description |
---|---|
<T> TypeConverter |
DefaultNumericConverter.getTypeConverter(ArgumentsMetadata arguments,
ParseState<T> state) |
Copyright © 2012–2017. All rights reserved.