Uses of Class
com.github.rvesse.airline.parser.ParseState
-
-
Uses of ParseState in com.github.rvesse.airline.examples.userguide.parser.options
Methods in com.github.rvesse.airline.examples.userguide.parser.options that return ParseState 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)Methods in com.github.rvesse.airline.examples.userguide.parser.options with parameters of type ParseState 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 ParseState in com.github.rvesse.airline.examples.userguide.restrictions.custom
Methods in com.github.rvesse.airline.examples.userguide.restrictions.custom with parameters of type ParseState Modifier and Type Method Description <T> voidMultipleOfRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)<T> voidMultipleOfRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)private <T> voidMultipleOfRestriction. validate(ParseState<T> state, java.lang.String optionTitle, java.lang.Object value) -
Uses of ParseState in com.github.rvesse.airline.parser
Fields in com.github.rvesse.airline.parser declared as ParseState Modifier and Type Field Description private ParseState<T>ParseResult. stateMethods in com.github.rvesse.airline.parser that return ParseState Modifier and Type Method Description ParseState<T>ParseResult. 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<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)protected ParseState<T>AbstractCommandParser. parseCommand(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state)protected ParseState<T>AbstractCommandParser. parseCommandOptionsAndArguments(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, CommandMetadata command)protected ParseState<T>AbstractCommandParser. parseGroup(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state)private ParseState<T>AbstractCommandParser. parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, java.util.List<OptionMetadata> allowedOptions)ParseState<T>ParseState. popContext()ParseState<T>ParseState. pushContext(Context location)protected ParseState<T>AbstractCommandParser. tryParse(GlobalMetadata<T> metadata, java.lang.Iterable<java.lang.String> args)Tries to parse the argumentsprotected ParseState<T>AbstractCommandParser. tryParse(GlobalMetadata<T> metadata, java.lang.String... args)Tries to parse the argumentsprotected ParseState<T>AbstractCommandParser. tryParse(ParserMetadata<T> parserConfig, CommandMetadata command, java.lang.Iterable<java.lang.String> args)Tries to parse the argumentsParseState<T>ParseState. withArgument(ArgumentsMetadata arguments, java.lang.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, java.lang.String rawValue)ParseState<T>ParseState. withUnparsedInput(java.lang.String input)Methods in com.github.rvesse.airline.parser with parameters of type ParseState Modifier and Type Method Description protected org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String>AbstractCommandParser. applyAliases(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state)protected TypeConverterAbstractParser. 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<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)protected ParseState<T>AbstractCommandParser. parseCommand(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state)protected ParseState<T>AbstractCommandParser. parseCommandOptionsAndArguments(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, CommandMetadata command)protected ParseState<T>AbstractCommandParser. parseGroup(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state)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 ParseState Constructor Description ParseResult(ParseState<T> state, java.util.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 ParseState Modifier and Type Method Description org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String>AliasResolver. resolveAliases(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.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 ParseState Modifier and Type Method Description protected voidCliParser. validate(ParseState<T> state)Validates the parser stateprotected voidSingleCommandParser. validate(ParseState<T> state, java.util.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 ParseState Modifier and Type Method Description <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 ParseState Modifier and Type Method Description 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)Methods in com.github.rvesse.airline.parser.options with parameters of type ParseState Modifier and Type Method Description protected booleanGreedyMaybeListValueOptionParser. canGreedySearch(ParseState<T> state)protected booleanMaybeListValueOptionParser. canGreedySearch(ParseState<T> state)Gets whether we can do a greedy search for list value(s)protected OptionMetadataAbstractOptionParser. findOption(ParseState<T> state, java.util.List<OptionMetadata> options, java.lang.String name)Tries to find an option with the given nameprotected OptionMetadataAbstractOptionParser. findOption(ParseState<T> state, java.util.List<OptionMetadata> options, java.lang.String name, OptionMetadata defaultValue)Tries to find an option with the given nameprotected booleanAbstractOptionParser. 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 booleanGreedyClassicGetOptParser. isSeparatorOrOption(ParseState<T> state, java.util.List<OptionMetadata> allowedOptions, java.lang.String argsSeparator, boolean shortForm, java.lang.String peekedToken)protected voidAbstractOptionParser. noValueForOption(ParseState<T> state, OptionMetadata option)Reports that no/insufficient values were provided for an optionParseState<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 ParseState in com.github.rvesse.airline.parser.suggester
Methods in com.github.rvesse.airline.parser.suggester that return ParseState Modifier and Type Method Description ParseState<T>SuggestionParser. parse(GlobalMetadata<T> metadata, java.lang.Iterable<java.lang.String> args) -
Uses of ParseState in com.github.rvesse.airline.restrictions
Methods in com.github.rvesse.airline.restrictions with parameters of type ParseState Modifier and Type Method Description <T> voidAbstractCommonRestriction. finalValidate(ParseState<T> state, ArgumentsMetadata arguments)<T> voidAbstractCommonRestriction. finalValidate(ParseState<T> state, OptionMetadata option)<T> voidArgumentsRestriction. finalValidate(ParseState<T> state, ArgumentsMetadata arguments)Method that is called after Airline has completed parsing<T> voidOptionRestriction. finalValidate(ParseState<T> state, OptionMetadata option)Method that is called after Airline has completed parsingstatic <T> java.lang.StringAbstractCommonRestriction. getArgumentTitle(ParseState<T> state, ArgumentsMetadata arguments)static <T> java.lang.StringAbstractCommonRestriction. getOptionTitle(ParseState<T> state, OptionMetadata option)<T> voidAbstractCommonRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)<T> voidAbstractCommonRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)<T> voidArgumentsRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)Method that is called after Airline has converted a string argument received into a strongly typed Java value<T> voidOptionRestriction. 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> voidAbstractCommonRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)<T> voidAbstractCommonRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)<T> voidArgumentsRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)Method that is called before Airline attempts to convert a string argument received into a strongly typed Java value<T> voidOptionRestriction. 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<T> voidGlobalRestriction. validate(ParseState<T> state)Validates the parser state<T> voidNone. 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 ParseState Modifier and Type Method Description protected <T> java.util.Set<java.lang.Object>AllowedValuesRestriction. createAllowedValues(ParseState<T> state, java.lang.String title, java.lang.Class<?> type, TypeConverter converter)<T> voidIsRequiredRestriction. finalValidate(ParseState<T> state, ArgumentsMetadata arguments)<T> voidIsRequiredRestriction. finalValidate(ParseState<T> state, OptionMetadata option)<T> voidOccurrencesRestriction. finalValidate(ParseState<T> state, ArgumentsMetadata arguments)<T> voidOccurrencesRestriction. finalValidate(ParseState<T> state, OptionMetadata option)private <T> booleanPartialRestriction. isApplicableToArgument(ParseState<T> state)private <T> booleanPartialRestriction. isApplicableToOption(ParseState<T> state, OptionMetadata option)<T> voidAllowedValuesRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)<T> voidAllowedValuesRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)<T> voidPartialRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)<T> voidPartialRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)<T> voidPortRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)<T> voidPortRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)<T> voidPositiveNegativeRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)<T> voidPositiveNegativeRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)<T> voidRangeRestriction. postValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.Object value)<T> voidRangeRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)<T> voidAbstractStringRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)<T> voidAbstractStringRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)<T> voidAllowedEnumValuesRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)<T> voidAllowedEnumValuesRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)<T> voidAllowedRawValuesRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)<T> voidAllowedRawValuesRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)<T> voidPartialRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)<T> voidPartialRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)<T> voidPathRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)<T> voidPathRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)<T> voidPatternRestriction. preValidate(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)<T> voidPatternRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)private <T> java.util.List<java.lang.String>OccurrencesRestriction. titles(ParseState<T> state, ArgumentsMetadata arguments)<T> voidNoOptionLikeValuesRestriction. validate(ParseState<T> state)protected abstract <T> ParseRestrictionViolatedExceptionAbstractStringRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.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)returnsfalseprotected abstract <T> ParseRestrictionViolatedExceptionAbstractStringRestriction. 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)returnsfalseprotected <T> ParseRestrictionViolatedExceptionEndsWithRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)protected <T> ParseRestrictionViolatedExceptionEndsWithRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value)protected <T> ParseRestrictionViolatedExceptionLengthRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)protected <T> ParseRestrictionViolatedExceptionLengthRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value)protected <T> ParseRestrictionViolatedExceptionNoOptionLikeValuesRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)protected <T> ParseRestrictionViolatedExceptionNoOptionLikeValuesRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value)protected <T> ParseRestrictionViolatedExceptionNotBlankRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)protected <T> ParseRestrictionViolatedExceptionNotBlankRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value)protected <T> ParseRestrictionViolatedExceptionNotEmptyRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)protected <T> ParseRestrictionViolatedExceptionNotEmptyRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value)protected <T> ParseRestrictionViolatedExceptionStartsWithRestriction. violated(ParseState<T> state, ArgumentsMetadata arguments, java.lang.String value)protected <T> ParseRestrictionViolatedExceptionStartsWithRestriction. violated(ParseState<T> state, OptionMetadata option, java.lang.String value) -
Uses of ParseState in com.github.rvesse.airline.restrictions.global
Methods in com.github.rvesse.airline.restrictions.global with parameters of type ParseState Modifier and Type Method Description <T> voidCommandRequiredRestriction. validate(ParseState<T> state)<T> voidNoMissingOptionValuesRestriction. validate(ParseState<T> state)<T> voidNoUnexpectedArgumentsRestriction. 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 ParseState Modifier and Type Method Description <T> voidAbstractRequiredUnlessRestriction. finalValidate(ParseState<T> state, ArgumentsMetadata arguments)<T> voidAbstractRequiredUnlessRestriction. finalValidate(ParseState<T> state, OptionMetadata option)<T> voidMutuallyExclusiveRestriction. finalValidate(ParseState<T> state, OptionMetadata option)<T> voidRequiredOnlyIfRestriction. finalValidate(ParseState<T> state, OptionMetadata option)<T> voidRequireFromRestriction. finalValidate(ParseState<T> state, OptionMetadata option)private <T> java.util.Collection<OptionMetadata>MutuallyExclusiveRestriction. getTaggedOptions(ParseState<T> state)private <T> java.util.Collection<OptionMetadata>RequireFromRestriction. getTaggedOptions(ParseState<T> state)<T> voidMutuallyExclusiveRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)<T> voidRequiredOnlyIfRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)<T> voidRequireFromRestriction. postValidate(ParseState<T> state, OptionMetadata option, java.lang.Object value)<T> voidMutuallyExclusiveRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)<T> voidRequiredOnlyIfRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)<T> voidRequireFromRestriction. preValidate(ParseState<T> state, OptionMetadata option, java.lang.String value)protected abstract <T> booleanAbstractRequiredUnlessRestriction. unless(ParseState<T> state, ArgumentsMetadata arguments)Answers whether the unless condition of the restriction is metprotected abstract <T> booleanAbstractRequiredUnlessRestriction. unless(ParseState<T> state, OptionMetadata option)Answers whether the unless condition of the restriction is metprotected <T> booleanRequiredUnlessEnvironmentRestriction. unless(ParseState<T> state, ArgumentsMetadata arguments)protected <T> booleanRequiredUnlessEnvironmentRestriction. 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 ParseState Modifier and Type Method Description <T> TypeConverterDefaultTypeConverterProvider. getTypeConverter(ArgumentsMetadata arguments, ParseState<T> state)<T> TypeConverterDefaultTypeConverterProvider. getTypeConverter(OptionMetadata option, ParseState<T> state)<T> TypeConverterTypeConverterProvider. getTypeConverter(ArgumentsMetadata arguments, ParseState<T> state)Gets the type converter to use for the given arguments and parser state<T> TypeConverterTypeConverterProvider. 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 ParseState Modifier and Type Method Description <T> TypeConverterDefaultNumericConverter. getTypeConverter(ArgumentsMetadata arguments, ParseState<T> state)<T> TypeConverterDefaultNumericConverter. getTypeConverter(OptionMetadata option, ParseState<T> state)
-