net.sourceforge.argparse4j.inf

Interface ArgumentContainer

All Known Subinterfaces:

ArgumentGroup, ArgumentParser, MutuallyExclusiveGroup, Subparser

All Known Implementing Classes:

ArgumentGroupImpl, ArgumentParserImpl, SubparserImpl

public interface ArgumentContainer

A container to which arguments can be added.

Since:

0.8.0

Method Summary

Modifier and Type	Method and Description
Argument	addArgument(String... nameOrFlags) Creates new Argument, adds it to this container and returns it.
ArgumentContainer	description(String description) Sets the description for the arguments of this container.

Method Detail

addArgument

Argument addArgument(String... nameOrFlags)

Creates new Argument, adds it to this container and returns it.

The nameOrFlags is either a single name of positional argument or a list of option strings for named argument, e.g. foo or -f, --foo.

Parameters:

nameOrFlags - A name or a list of option strings of new Argument.

Returns:

Argument object.

description

ArgumentContainer description(String description)

Sets the description for the arguments of this container.

Parameters:

description - The description of this container.

Returns:

this