Modifier and Type | Method and Description |
---|---|
ParseState<T> |
ParseResult.getState()
Gets the final parser state
|
static <T> ParseState<T> |
ParseState.newInstance() |
protected ParseState<T> |
AbstractCommandParser.parseCommand(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state) |
protected ParseState<T> |
AbstractCommandParser.parseCommandOptionsAndArguments(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state,
CommandMetadata command) |
protected ParseState<T> |
AbstractCommandParser.parseGroup(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state) |
ParseState<T> |
ParseState.popContext() |
ParseState<T> |
ParseState.pushContext(Context location) |
protected ParseState<T> |
AbstractCommandParser.tryParse(GlobalMetadata<T> metadata,
Iterable<String> args)
Tries to parse the arguments
|
protected ParseState<T> |
AbstractCommandParser.tryParse(GlobalMetadata<T> metadata,
String... args)
Tries to parse the arguments
|
protected ParseState<T> |
AbstractCommandParser.tryParse(ParserMetadata<T> parserConfig,
CommandMetadata command,
Iterable<String> args)
Tries to parse the arguments
|
ParseState<T> |
ParseState.withArgument(ArgumentsMetadata arguments,
String rawValue) |
ParseState<T> |
ParseState.withCommand(CommandMetadata command) |
ParseState<T> |
ParseState.withConfiguration(ParserMetadata<T> parserConfig) |
ParseState<T> |
ParseState.withGlobal(GlobalMetadata<T> global) |
ParseState<T> |
ParseState.withGroup(CommandGroupMetadata group) |
ParseState<T> |
ParseState.withOption(OptionMetadata option) |
ParseState<T> |
ParseState.withOptionValue(OptionMetadata option,
String rawValue) |
ParseState<T> |
ParseState.withUnparsedInput(String input) |
Modifier and Type | Method and Description |
---|---|
protected org.apache.commons.collections4.iterators.PeekingIterator<String> |
AbstractCommandParser.applyAliases(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state) |
protected TypeConverter |
AbstractParser.getTypeConverter(ParseState<T> state)
Gets the type converter to use for converting arguments into
option/argument values
|
protected ParseState<T> |
AbstractCommandParser.parseCommand(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state) |
protected ParseState<T> |
AbstractCommandParser.parseCommandOptionsAndArguments(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state,
CommandMetadata command) |
protected ParseState<T> |
AbstractCommandParser.parseGroup(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state) |
Constructor and Description |
---|
ParseResult(ParseState<T> state,
Collection<ParseException> errors) |
Modifier and Type | Method and Description |
---|---|
org.apache.commons.collections4.iterators.PeekingIterator<String> |
AliasResolver.resolveAliases(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens,
ParseState<T> state) |
Modifier and Type | Method and Description |
---|---|
protected void |
CliParser.validate(ParseState<T> state)
Validates the parser state
|
protected void |
SingleCommandParser.validate(ParseState<T> state,
List<GlobalRestriction> restrictions)
Validates the parser state
|
Modifier and Type | Method and Description |
---|---|
<T> ParseResult<T> |
ParserErrorHandler.finished(ParseState<T> state)
Prepares the parser result
|
<T> ParseResult<T> |
FailFast.finished(ParseState<T> state) |
<T> ParseResult<T> |
FailAll.finished(ParseState<T> state) |
<T> ParseResult<T> |
CollectAll.finished(ParseState<T> state) |
Modifier and Type | Method and Description |
---|---|
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 |
---|---|
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 |
---|---|
ParseState<T> |
SuggestionParser.parse(GlobalMetadata<T> metadata,
Iterable<String> args) |
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) |
<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) |
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 |
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 |
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) |
<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) |
<T> void |
None.validate(ParseState<T> state) |
<T> void |
GlobalRestriction.validate(ParseState<T> state)
Validates the parser state
|
Modifier and Type | Method and Description |
---|---|
protected <T> Set<Object> |
AllowedValuesRestriction.createAllowedValues(ParseState<T> state,
String title,
Class<?> type,
TypeConverter converter) |
<T> void |
OccurrencesRestriction.finalValidate(ParseState<T> state,
ArgumentsMetadata arguments) |
<T> void |
IsRequiredRestriction.finalValidate(ParseState<T> state,
ArgumentsMetadata arguments) |
<T> void |
OccurrencesRestriction.finalValidate(ParseState<T> state,
OptionMetadata option) |
<T> void |
IsRequiredRestriction.finalValidate(ParseState<T> state,
OptionMetadata option) |
<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 |
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,
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) |
<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,
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 |
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 |
NoUnexpectedArgumentsRestriction.validate(ParseState<T> state) |
<T> void |
NoMissingOptionValuesRestriction.validate(ParseState<T> state) |
<T> void |
CommandRequiredRestriction.validate(ParseState<T> state) |
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(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) |
<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(ArgumentsMetadata arguments,
ParseState<T> state) |
<T> TypeConverter |
DefaultNumericConverter.getTypeConverter(OptionMetadata option,
ParseState<T> state) |
Copyright © 2012–2017. All rights reserved.