com.github.rvesse.airline.parser.options

Class MaybePairValueOptionParser<T>

java.lang.Object

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

com.github.rvesse.airline.parser.options.AbstractOptionParser<T>

com.github.rvesse.airline.parser.options.MaybePairValueOptionParser<T>

All Implemented Interfaces:

OptionParser<T>

public class MaybePairValueOptionParser<T>
extends AbstractOptionParser<T>

An options parser that expects the name and values to be white space separated e.g. --name value but which allows for the values to be a non-whitespace separated pair

So for example --name foo=bar would be treated as the values foo and bar passed to the --name option. This parser would also support --name foo bar and interpret them in the same way and as such is a convenient hybrid of the StandardOptionParser and the ListValueOptionParser for cases where you have arity 2 options that users may either express the two values as separate values or in pair style.

You can also omit the whitespace between the name and the values when using a single character name of the option similar to how the ClassicGetOptParser works. For example -nfoo=bar is equivalent to our previous example assuming that -n is an alternative name for the same option as --name.

The default separator for values is = but this can be configured as desired.

Constructor Summary

Constructors

Constructor and Description
MaybePairValueOptionParser()
MaybePairValueOptionParser(char separator)

Method Summary

Methods

Modifier and Type	Method and Description
protected List<String>	getValues(String list)
ParseState<T>	parseOptions(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, List<OptionMetadata> allowedOptions) Parses one/more options from the token stream

Methods inherited from class com.github.rvesse.airline.parser.options.AbstractOptionParser

findOption, findOption, hasShortNamePrefix

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

MaybePairValueOptionParser

public MaybePairValueOptionParser()

MaybePairValueOptionParser

public MaybePairValueOptionParser(char separator)

Method Detail

getValues

protected final List<String> getValues(String list)

parseOptions

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

Description copied from interface: OptionParser

Parses one/more options from the token stream

Parameters:

tokens - Tokens

state - Current parser state

allowedOptions - Allowed options at this point of the parsing

Returns:

New parser state, may return null if this parser could not parse the next token as an option