com.github.ajalt.clikt.parsers

Interface OptionParser

All Known Implementing Classes:

FlagOptionParser, OptionWithValuesParser

public OptionParser

A parser for interface Options.

All functions should be pure, since the same command instance can parse arguments multiple times.

See Also:

interface Option

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OptionParser.Invocation The input from a single instance of an option input.
static class	OptionParser.ParseResult

Method Summary

Modifier and Type	Method and Description
OptionParser.ParseResult	parseLongOpt(Option option, java.lang.String name, java.util.List<java.lang.String> argv, int index, java.lang.String explicitValue) Parse a single long option and its value.
OptionParser.ParseResult	parseShortOpt(Option option, java.lang.String name, java.util.List<java.lang.String> argv, int index, int optionIndex) Parse a single short option and its value.

Method Detail

parseShortOpt

OptionParser.ParseResult parseShortOpt(Option option,
                                       java.lang.String name,
                                       java.util.List<java.lang.String> argv,
                                       int index,
                                       int optionIndex)

Parse a single short option and its value.

Parameters:

name - The name of the flag used to invoke this option

argv - The entire list of command line arguments for the command

index - The index of the option flag in argv, which may contain multiple short parameters.

optionIndex - The index of the option within argv\[index]

parseLongOpt

OptionParser.ParseResult parseLongOpt(Option option,
                                      java.lang.String name,
                                      java.util.List<java.lang.String> argv,
                                      int index,
                                      java.lang.String explicitValue)

Parse a single long option and its value.

Parameters:

name - The name of the flag used to invoke this option

argv - The entire list of command line arguments for the command

index - The index of the option flag in argv, which may contain an '=' with the first value