Module net.sourceforge.argparse4j

Package net.sourceforge.argparse4j.internal

Class ArgumentGroupImpl

java.lang.Object

net.sourceforge.argparse4j.internal.ArgumentGroupImpl

All Implemented Interfaces:

ArgumentContainer, 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.

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<ArgumentImpl>	args_
private ArgumentParserImpl	argumentParser_
private java.lang.String	description_
private int	index_	Index in ArgumentParserImpl.
private boolean	mutex_	true if this is a mutually exclusive group.
private boolean	required_	true if one of the arguments in this group must be specified.
private java.lang.String	title_

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, adds it to this container and returns it.
ArgumentGroupImpl	description(java.lang.String description)	Sets the description for the arguments of this container.
java.util.List<ArgumentImpl>	getArgs()
(package private) int	getIndex()
(package private) boolean	isMutex()
boolean	isRequired()
(package private) 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.
(package private) void	setIndex(int index)
(package private) void	setMutex(boolean mutex)

Methods inherited from class java.lang.Object

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

Field Detail

index_

private int index_

Index in ArgumentParserImpl.

title_

private final java.lang.String title_

description_

private java.lang.String description_

argumentParser_

private final ArgumentParserImpl argumentParser_

args_

private final java.util.List<ArgumentImpl> args_

mutex_

private boolean mutex_

true if this is a mutually exclusive group.

required_

private boolean required_

true if one of the arguments in this group must be specified.

Constructor Detail

ArgumentGroupImpl

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

Method Detail

description

public ArgumentGroupImpl description(java.lang.String description)

Description copied from interface: ArgumentContainer

Sets the description for the arguments of this container.

Specified by:

description in interface ArgumentContainer

Specified by:

description in interface ArgumentGroup

Specified by:

description in interface MutuallyExclusiveGroup

Parameters:

description - The description of this container.

Returns:

this

addArgument

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

Description copied from interface: ArgumentContainer

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.

Specified by:

addArgument in interface ArgumentContainer

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

int getIndex()

setIndex

void setIndex(int index)

isMutex

boolean isMutex()

setMutex

void setMutex(boolean mutex)

isRequired

public boolean isRequired()

getArgs

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

isSeparateHelp

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.