Module com.github.rvesse.airline

Package com.github.rvesse.airline.parser

Class AbstractCommandParser<T>

java.lang.Object

com.github.rvesse.airline.parser.AbstractParser<T>

com.github.rvesse.airline.parser.AbstractCommandParser<T>

Type Parameters:

T - Command type

Direct Known Subclasses:

CliParser, SingleCommandParser, SuggestionParser

public abstract class AbstractCommandParser<T>
extends AbstractParser<T>

Abstract implementation of a parser for commands that can cope with both CLI and Single Command parsing

Constructor Summary

Constructors

Constructor	Description
AbstractCommandParser()

Method Summary

Modifier and Type	Method	Description
protected org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String>	applyAliases(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state)
private ParseState<T>	parseArg(ParseState<T> state, org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ArgumentsMetadata arguments, OptionMetadata defaultOption)
private ParseState<T>	parseArgs(ParseState<T> state, org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ArgumentsMetadata arguments, OptionMetadata defaultOption)
protected ParseState<T>	parseCommand(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state)
protected ParseState<T>	parseCommandOptionsAndArguments(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, CommandMetadata command)
protected ParseState<T>	parseGroup(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state)
private ParseState<T>	parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, java.util.List<OptionMetadata> allowedOptions)
protected ParseState<T>	tryParse(GlobalMetadata<T> metadata, java.lang.Iterable<java.lang.String> args)	Tries to parse the arguments
protected ParseState<T>	tryParse(GlobalMetadata<T> metadata, java.lang.String... args)	Tries to parse the arguments
protected ParseState<T>	tryParse(ParserMetadata<T> parserConfig, CommandMetadata command, java.lang.Iterable<java.lang.String> args)	Tries to parse the arguments

Methods inherited from class com.github.rvesse.airline.parser.AbstractParser

getTypeConverter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractCommandParser

public AbstractCommandParser()

Method Detail

tryParse

protected ParseState<T> tryParse(GlobalMetadata<T> metadata,
                                 java.lang.String... args)

Tries to parse the arguments

Parameters:

metadata - Global Metadata

args - Arguments

Returns:

Parser State

tryParse

protected ParseState<T> tryParse(GlobalMetadata<T> metadata,
                                 java.lang.Iterable<java.lang.String> args)

Tries to parse the arguments

Parameters:

metadata - Global Metadata

args - Arguments

Returns:

Parser State

applyAliases

protected org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> applyAliases(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens,
                                                                                                   ParseState<T> state)

tryParse

protected ParseState<T> tryParse(ParserMetadata<T> parserConfig,
                                 CommandMetadata command,
                                 java.lang.Iterable<java.lang.String> args)

Tries to parse the arguments

Parameters:

parserConfig - Parser Configuration

command - Command meta-data

args - Arguments

Returns:

Parser State

parseCommand

protected ParseState<T> parseCommand(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens,
                                     ParseState<T> state)

parseCommandOptionsAndArguments

protected ParseState<T> parseCommandOptionsAndArguments(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens,
                                                        ParseState<T> state,
                                                        CommandMetadata command)

parseGroup

protected ParseState<T> parseGroup(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens,
                                   ParseState<T> state)

parseOptions

private ParseState<T> parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens,
                                   ParseState<T> state,
                                   java.util.List<OptionMetadata> allowedOptions)

parseArgs

private ParseState<T> parseArgs(ParseState<T> state,
                                org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens,
                                ArgumentsMetadata arguments,
                                OptionMetadata defaultOption)

parseArg

private ParseState<T> parseArg(ParseState<T> state,
                               org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens,
                               ArgumentsMetadata arguments,
                               OptionMetadata defaultOption)