de.vandermeer.skb.interfaces.application

Interface App_CliParser

public interface App_CliParser

Base for a CLI parser.

Since:

v0.0.2

Version:

v0.0.2 build 170502 (02-May-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Method Summary

Modifier and Type	Method and Description
default App_CliParser	addAllOptions(Iterable<?> options) Adds all options to the parser.
default App_CliParser	addAllOptions(Object[] options) Adds all options to the parser.
App_CliParser	addOption(Object option) Adds a new option to the parser.
Set<String>	getAddedOptions() Returns the options already added, short or long.
Set<ApoBaseC>	getAllOptions() Returns a set of all options.
Set<Apo_SimpleC>	getSimpleOptions() Returns all simple options added to the parser.
Set<Apo_TypedC<?>>	getTypedOptions() Returns all typed options added to the parser.
default boolean	hasOption(ApoBase option) Tests if an option is already added to the command line parser.
int	numberLong() Statistic method: returns number of CLI arguments with long option.
int	numberShort() Statistic method: returns number of CLI arguments with short option.
void	parse(String[] args) Parses command line arguments set values for CLI options.
default ArrayList<StrBuilder>	usage() Prints usage information for the CLI parser including all CLI options.
default ArrayList<StrBuilder>	usage(int width) Prints usage information for the CLI parser including all CLI options.

Method Detail

numberShort

int numberShort()

Statistic method: returns number of CLI arguments with short option.

Returns:

number of CLI arguments with short option

numberLong

int numberLong()

Statistic method: returns number of CLI arguments with long option.

Returns:

number of CLI arguments with long option

addAllOptions

default App_CliParser addAllOptions(Object[] options)
                             throws IllegalStateException

Adds all options to the parser.

Parameters:

options - the options to be added, ignored if null, any null element is ignored as well

Returns:

self to allow chaining

Throws:

IllegalStateException - if the option is already in use

addAllOptions

default App_CliParser addAllOptions(Iterable<?> options)
                             throws IllegalStateException

Adds all options to the parser.

Parameters:

options - the options to be added, ignored if null, any null element is ignored as well

Returns:

self to allow chaining

Throws:

IllegalStateException - if the option is already in use

addOption

App_CliParser addOption(Object option)
                 throws IllegalStateException

Adds a new option to the parser.

Parameters:

option - the option to be added, ignored if null

Returns:

self to allow chaining

Throws:

IllegalStateException - if the option is already in use

getAddedOptions

Set<String> getAddedOptions()

Returns the options already added, short or long.

Returns:

already added options, empty if none added

getSimpleOptions

Set<Apo_SimpleC> getSimpleOptions()

Returns all simple options added to the parser.

Returns:

all simple options, empty array if none added

getTypedOptions

Set<Apo_TypedC<?>> getTypedOptions()

Returns all typed options added to the parser.

Returns:

all typed options, empty array if none added

getAllOptions

Set<ApoBaseC> getAllOptions()

Returns a set of all options.

Returns:

set of all options, empty if none set

hasOption

default boolean hasOption(ApoBase option)

Tests if an option is already added to the command line parser.

Parameters:

option - the option to test for

Returns:

true if parser has the option (short or long), false otherwise (option was null or not an instance of ApoBaseC

parse

void parse(String[] args)
    throws CliParseException,
           IllegalStateException

Parses command line arguments set values for CLI options.

Parameters:

args - command line arguments

Throws:

CliParseException - if a parsing error happened, for instance a required option was not present in the arguments

IllegalStateException - if a parsing error happened, for instance a required option was not present in the arguments

usage

default ArrayList<StrBuilder> usage(int width)

Prints usage information for the CLI parser including all CLI options.

Parameters:

width - the console columns or width of each output line

Returns:

list of lines with usage information

usage

default ArrayList<StrBuilder> usage()

Prints usage information for the CLI parser including all CLI options.

Returns:

list of lines with usage information