Package net.sourceforge.argparse4j.internal

Class ArgumentGroupImpl

java.lang.Object

net.sourceforge.argparse4j.internal.ArgumentGroupImpl

All Implemented Interfaces:

ArgumentGroup, MutuallyExclusiveGroup

public final class ArgumentGroupImpl
extends java.lang.Object
implements ArgumentGroup, MutuallyExclusiveGroup

The application code must not use this class directly. This class implements both mutually exclusive group and just a conceptual group.

Constructor Summary

Constructors

Constructor	Description
ArgumentGroupImpl(ArgumentParserImpl argumentParser, java.lang.String title)

Method Summary

Modifier and Type	Method	Description
ArgumentImpl	addArgument(java.lang.String... nameOrFlags)	Creates new Argument and adds it to the underlining parser and returns it.
ArgumentGroupImpl	description(java.lang.String description)	Sets description to customize help message of this group.
java.util.List<ArgumentImpl>	getArgs()
int	getIndex()
boolean	isMutex()
boolean	isRequired()
boolean	isSeparateHelp()	Returns true if the help message for this group should be in separate group.
void	printHelp(java.io.PrintWriter writer, int format_width)
ArgumentGroupImpl	required(boolean required)	If true is given, one of the arguments in this group must be specified otherwise error will be issued.
void	setIndex(int index)
void	setMutex(boolean mutex)

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentGroupImpl

public ArgumentGroupImpl(ArgumentParserImpl argumentParser,
                         java.lang.String title)

Method Detail

description

public ArgumentGroupImpl description(java.lang.String description)

Description copied from interface: ArgumentGroup

Sets description to customize help message of this group.

Specified by:

description in interface ArgumentGroup

Specified by:

description in interface MutuallyExclusiveGroup

Parameters:

description - The description of this group.

Returns:

this

addArgument

public ArgumentImpl addArgument(java.lang.String... nameOrFlags)

Description copied from interface: ArgumentGroup

Creates new Argument and adds it to the underlining parser and returns it.

See ArgumentParser.addArgument(String...) for details.

Specified by:

addArgument in interface ArgumentGroup

Specified by:

addArgument in interface MutuallyExclusiveGroup

Parameters:

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

Returns:

Argument object.

required

public ArgumentGroupImpl required(boolean required)

Description copied from interface: MutuallyExclusiveGroup

If true is given, one of the arguments in this group must be specified otherwise error will be issued.

The default value is false.

Specified by:

required in interface MutuallyExclusiveGroup

Parameters:

required - true or false

Returns:

this

printHelp

public void printHelp(java.io.PrintWriter writer,
                      int format_width)

getIndex

public int getIndex()

setIndex

public void setIndex(int index)

isMutex

public boolean isMutex()

setMutex

public void setMutex(boolean mutex)

isRequired

public boolean isRequired()

getArgs

public java.util.List<ArgumentImpl> getArgs()

isSeparateHelp

public boolean isSeparateHelp()

Returns true if the help message for this group should be in separate group.

Returns:

true if the help message for this group should be in separate group.