Uses of Class
com.github.rvesse.airline.parser.ParseState
Packages that use ParseState
Package
Description
-
Uses of ParseState in com.github.rvesse.airline.examples.userguide.parser.options
Methods in com.github.rvesse.airline.examples.userguide.parser.options that return ParseStateModifier and TypeMethodDescriptionJdbcStyleOptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) Methods in com.github.rvesse.airline.examples.userguide.parser.options with parameters of type ParseStateModifier and TypeMethodDescriptionJdbcStyleOptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) -
Uses of ParseState in com.github.rvesse.airline.examples.userguide.restrictions.custom
Methods in com.github.rvesse.airline.examples.userguide.restrictions.custom with parameters of type ParseStateModifier and TypeMethodDescription<T> void
MultipleOfRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) <T> void
MultipleOfRestriction.postValidate
(ParseState<T> state, OptionMetadata option, Object value) private <T> void
MultipleOfRestriction.validate
(ParseState<T> state, String optionTitle, Object value) -
Uses of ParseState in com.github.rvesse.airline.parser
Fields in com.github.rvesse.airline.parser declared as ParseStateMethods in com.github.rvesse.airline.parser that return ParseStateModifier and TypeMethodDescriptionParseResult.getState()
Gets the final parser statestatic <T> ParseState
<T> ParseState.newInstance()
private ParseState
<T> AbstractCommandParser.parseArg
(ParseState<T> state, org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ArgumentsMetadata arguments, OptionMetadata defaultOption) private ParseState
<T> AbstractCommandParser.parseArgs
(ParseState<T> state, org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ArgumentsMetadata arguments, OptionMetadata defaultOption) 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) private ParseState
<T> AbstractCommandParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) ParseState.popContext()
ParseState.pushContext
(Context location) protected ParseState
<T> AbstractCommandParser.tryParse
(GlobalMetadata<T> metadata, Iterable<String> args) Tries to parse the argumentsprotected ParseState
<T> AbstractCommandParser.tryParse
(GlobalMetadata<T> metadata, String... args) Tries to parse the argumentsprotected ParseState
<T> AbstractCommandParser.tryParse
(ParserMetadata<T> parserConfig, CommandMetadata command, Iterable<String> args) Tries to parse the argumentsParseState.withArgument
(ArgumentsMetadata arguments, String rawValue) ParseState.withCommand
(CommandMetadata command) ParseState.withConfiguration
(ParserMetadata<T> parserConfig) ParseState.withGlobal
(GlobalMetadata<T> global) ParseState.withGroup
(CommandGroupMetadata group) ParseState.withOption
(OptionMetadata option) ParseState.withOptionValue
(OptionMetadata option, String rawValue) ParseState.withUnparsedInput
(String input) Methods in com.github.rvesse.airline.parser with parameters of type ParseStateModifier and TypeMethodDescriptionprotected org.apache.commons.collections4.iterators.PeekingIterator
<String> AbstractCommandParser.applyAliases
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state) protected final TypeConverter
AbstractParser.getTypeConverter
(ParseState<T> state) Gets the type converter to use for converting arguments into option/argument valuesprivate ParseState
<T> AbstractCommandParser.parseArg
(ParseState<T> state, org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ArgumentsMetadata arguments, OptionMetadata defaultOption) private ParseState
<T> AbstractCommandParser.parseArgs
(ParseState<T> state, org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ArgumentsMetadata arguments, OptionMetadata defaultOption) 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) private ParseState
<T> AbstractCommandParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) Constructors in com.github.rvesse.airline.parser with parameters of type ParseStateModifierConstructorDescriptionParseResult
(ParseState<T> state, Collection<ParseException> errors) -
Uses of ParseState in com.github.rvesse.airline.parser.aliases
Methods in com.github.rvesse.airline.parser.aliases with parameters of type ParseStateModifier and TypeMethodDescriptionorg.apache.commons.collections4.iterators.PeekingIterator
<String> AliasResolver.resolveAliases
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state) -
Uses of ParseState in com.github.rvesse.airline.parser.command
Methods in com.github.rvesse.airline.parser.command with parameters of type ParseStateModifier and TypeMethodDescriptionprotected void
CliParser.validate
(ParseState<T> state) Validates the parser stateprotected void
SingleCommandParser.validate
(ParseState<T> state, List<GlobalRestriction> restrictions) Validates the parser state -
Uses of ParseState in com.github.rvesse.airline.parser.errors.handlers
Methods in com.github.rvesse.airline.parser.errors.handlers with parameters of type ParseStateModifier and TypeMethodDescription<T> ParseResult
<T> CollectAll.finished
(ParseState<T> state) <T> ParseResult
<T> FailAll.finished
(ParseState<T> state) <T> ParseResult
<T> FailFast.finished
(ParseState<T> state) <T> ParseResult
<T> ParserErrorHandler.finished
(ParseState<T> state) Prepares the parser result -
Uses of ParseState in com.github.rvesse.airline.parser.options
Methods in com.github.rvesse.airline.parser.options that return ParseStateModifier and TypeMethodDescriptionAbstractNameValueOptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) ClassicGetOptParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) ListValueOptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) MaybeListValueOptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) MaybePairValueOptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) OptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) Parses one/more options from the token streamStandardOptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) Methods in com.github.rvesse.airline.parser.options with parameters of type ParseStateModifier and TypeMethodDescriptionprotected boolean
GreedyMaybeListValueOptionParser.canGreedySearch
(ParseState<T> state) protected boolean
MaybeListValueOptionParser.canGreedySearch
(ParseState<T> state) Gets whether we can do a greedy search for list value(s)protected final OptionMetadata
AbstractOptionParser.findOption
(ParseState<T> state, List<OptionMetadata> options, String name) Tries to find an option with the given nameprotected final OptionMetadata
AbstractOptionParser.findOption
(ParseState<T> state, List<OptionMetadata> options, String name, OptionMetadata defaultValue) Tries to find an option with the given nameprotected boolean
AbstractOptionParser.isSeparatorOrOption
(ParseState<T> state, List<OptionMetadata> allowedOptions, String argsSeparator, boolean shortForm, String peekedToken) Checks whether the next value is an arguments separator or optionprotected boolean
GreedyClassicGetOptParser.isSeparatorOrOption
(ParseState<T> state, List<OptionMetadata> allowedOptions, String argsSeparator, boolean shortForm, String peekedToken) protected void
AbstractOptionParser.noValueForOption
(ParseState<T> state, OptionMetadata option) Reports that no/insufficient values were provided for an optionAbstractNameValueOptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) ClassicGetOptParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) ListValueOptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) MaybeListValueOptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) MaybePairValueOptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) OptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) Parses one/more options from the token streamStandardOptionParser.parseOptions
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) -
Uses of ParseState in com.github.rvesse.airline.parser.suggester
Methods in com.github.rvesse.airline.parser.suggester that return ParseStateModifier and TypeMethodDescriptionSuggestionParser.parse
(GlobalMetadata<T> metadata, Iterable<String> args) -
Uses of ParseState in com.github.rvesse.airline.restrictions
Methods in com.github.rvesse.airline.restrictions with parameters of type ParseStateModifier and TypeMethodDescription<T> void
AbstractCommonRestriction.finalValidate
(ParseState<T> state, ArgumentsMetadata arguments) <T> void
AbstractCommonRestriction.finalValidate
(ParseState<T> state, OptionMetadata option) <T> void
ArgumentsRestriction.finalValidate
(ParseState<T> state, ArgumentsMetadata arguments) Method that is called after Airline has completed parsing<T> void
OptionRestriction.finalValidate
(ParseState<T> state, OptionMetadata option) Method that is called after Airline has completed parsingstatic <T> String
AbstractCommonRestriction.getArgumentTitle
(ParseState<T> state, ArgumentsMetadata arguments) static <T> String
AbstractCommonRestriction.getOptionTitle
(ParseState<T> state, OptionMetadata option) <T> void
AbstractCommonRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) <T> void
AbstractCommonRestriction.postValidate
(ParseState<T> state, OptionMetadata option, Object value) <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
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.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) <T> void
AbstractCommonRestriction.preValidate
(ParseState<T> state, OptionMetadata option, String 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
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
GlobalRestriction.validate
(ParseState<T> state) Validates the parser state<T> void
None.validate
(ParseState<T> state) -
Uses of ParseState in com.github.rvesse.airline.restrictions.common
Methods in com.github.rvesse.airline.restrictions.common with parameters of type ParseStateModifier and TypeMethodDescriptionAllowedValuesRestriction.createAllowedValues
(ParseState<T> state, String title, Class<?> type, TypeConverter converter) <T> void
IsRequiredRestriction.finalValidate
(ParseState<T> state, ArgumentsMetadata arguments) <T> void
IsRequiredRestriction.finalValidate
(ParseState<T> state, OptionMetadata option) <T> void
OccurrencesRestriction.finalValidate
(ParseState<T> state, ArgumentsMetadata arguments) <T> void
OccurrencesRestriction.finalValidate
(ParseState<T> state, OptionMetadata option) private <T> boolean
PartialRestriction.isApplicableToArgument
(ParseState<T> state) private <T> boolean
PartialRestriction.isApplicableToOption
(ParseState<T> state, OptionMetadata option) <T> void
AllowedValuesRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) <T> void
AllowedValuesRestriction.postValidate
(ParseState<T> state, OptionMetadata option, Object value) <T> void
PartialRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) <T> void
PartialRestriction.postValidate
(ParseState<T> state, OptionMetadata option, Object value) <T> void
PortRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) <T> void
PortRestriction.postValidate
(ParseState<T> state, OptionMetadata option, Object value) <T> void
PositiveNegativeRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) <T> void
PositiveNegativeRestriction.postValidate
(ParseState<T> state, OptionMetadata option, Object value) <T> void
RangeRestriction.postValidate
(ParseState<T> state, ArgumentsMetadata arguments, Object value) <T> void
RangeRestriction.postValidate
(ParseState<T> state, OptionMetadata option, Object value) final <T> void
AbstractStringRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) final <T> void
AbstractStringRestriction.preValidate
(ParseState<T> state, OptionMetadata option, String value) <T> void
AllowedEnumValuesRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) <T> void
AllowedEnumValuesRestriction.preValidate
(ParseState<T> state, OptionMetadata option, String value) <T> void
AllowedRawValuesRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) <T> void
AllowedRawValuesRestriction.preValidate
(ParseState<T> state, OptionMetadata option, String value) <T> void
PartialRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) <T> void
PartialRestriction.preValidate
(ParseState<T> state, OptionMetadata option, String value) <T> void
PathRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) <T> void
PathRestriction.preValidate
(ParseState<T> state, OptionMetadata option, String value) <T> void
PatternRestriction.preValidate
(ParseState<T> state, ArgumentsMetadata arguments, String value) <T> void
PatternRestriction.preValidate
(ParseState<T> state, OptionMetadata option, String value) OccurrencesRestriction.titles
(ParseState<T> state, ArgumentsMetadata arguments) <T> void
NoOptionLikeValuesRestriction.validate
(ParseState<T> state) 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 ifAbstractStringRestriction.isValid(String)
returnsfalse
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 ifAbstractStringRestriction.isValid(String)
returnsfalse
protected <T> ParseRestrictionViolatedException
EndsWithRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) protected <T> ParseRestrictionViolatedException
EndsWithRestriction.violated
(ParseState<T> state, OptionMetadata option, String value) protected <T> ParseRestrictionViolatedException
LengthRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) protected <T> ParseRestrictionViolatedException
LengthRestriction.violated
(ParseState<T> state, OptionMetadata option, String value) protected <T> ParseRestrictionViolatedException
NoOptionLikeValuesRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) protected <T> ParseRestrictionViolatedException
NoOptionLikeValuesRestriction.violated
(ParseState<T> state, OptionMetadata option, String value) protected <T> ParseRestrictionViolatedException
NotBlankRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) protected <T> ParseRestrictionViolatedException
NotBlankRestriction.violated
(ParseState<T> state, OptionMetadata option, String value) protected <T> ParseRestrictionViolatedException
NotEmptyRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) protected <T> ParseRestrictionViolatedException
NotEmptyRestriction.violated
(ParseState<T> state, OptionMetadata option, String value) protected <T> ParseRestrictionViolatedException
StartsWithRestriction.violated
(ParseState<T> state, ArgumentsMetadata arguments, String value) protected <T> ParseRestrictionViolatedException
StartsWithRestriction.violated
(ParseState<T> state, OptionMetadata option, String value) -
Uses of ParseState in com.github.rvesse.airline.restrictions.global
Methods in com.github.rvesse.airline.restrictions.global with parameters of type ParseStateModifier and TypeMethodDescription<T> void
CommandRequiredRestriction.validate
(ParseState<T> state) <T> void
NoMissingOptionValuesRestriction.validate
(ParseState<T> state) <T> void
NoUnexpectedArgumentsRestriction.validate
(ParseState<T> state) -
Uses of ParseState in com.github.rvesse.airline.restrictions.options
Methods in com.github.rvesse.airline.restrictions.options with parameters of type ParseStateModifier and TypeMethodDescription<T> void
AbstractRequiredUnlessRestriction.finalValidate
(ParseState<T> state, ArgumentsMetadata arguments) <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) private <T> Collection
<OptionMetadata> MutuallyExclusiveRestriction.getTaggedOptions
(ParseState<T> state) private <T> Collection
<OptionMetadata> RequireFromRestriction.getTaggedOptions
(ParseState<T> state) <T> void
MutuallyExclusiveRestriction.postValidate
(ParseState<T> state, OptionMetadata option, Object value) <T> void
RequiredOnlyIfRestriction.postValidate
(ParseState<T> state, OptionMetadata option, Object value) <T> void
RequireFromRestriction.postValidate
(ParseState<T> state, OptionMetadata option, Object value) <T> void
MutuallyExclusiveRestriction.preValidate
(ParseState<T> state, OptionMetadata option, String value) <T> void
RequiredOnlyIfRestriction.preValidate
(ParseState<T> state, OptionMetadata option, String value) <T> void
RequireFromRestriction.preValidate
(ParseState<T> state, OptionMetadata option, String value) protected abstract <T> boolean
AbstractRequiredUnlessRestriction.unless
(ParseState<T> state, ArgumentsMetadata arguments) Answers whether the unless condition of the restriction is metprotected 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, ArgumentsMetadata arguments) protected <T> boolean
RequiredUnlessEnvironmentRestriction.unless
(ParseState<T> state, OptionMetadata option) -
Uses of ParseState in com.github.rvesse.airline.types
Methods in com.github.rvesse.airline.types with parameters of type ParseStateModifier and TypeMethodDescription<T> TypeConverter
DefaultTypeConverterProvider.getTypeConverter
(ArgumentsMetadata arguments, ParseState<T> state) <T> TypeConverter
DefaultTypeConverterProvider.getTypeConverter
(OptionMetadata option, 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<T> TypeConverter
TypeConverterProvider.getTypeConverter
(OptionMetadata option, ParseState<T> state) Gets the type converter to use for the given option and parser state -
Uses of ParseState in com.github.rvesse.airline.types.numerics
Methods in com.github.rvesse.airline.types.numerics with parameters of type ParseStateModifier and TypeMethodDescription<T> TypeConverter
DefaultNumericConverter.getTypeConverter
(ArgumentsMetadata arguments, ParseState<T> state) <T> TypeConverter
DefaultNumericConverter.getTypeConverter
(OptionMetadata option, ParseState<T> state)