Package net.sourceforge.argparse4j.impl

Class Arguments

java.lang.Object

net.sourceforge.argparse4j.impl.Arguments

public final class Arguments
extends java.lang.Object

This class provides useful shortcuts and constants.

They are mainly used to specify parameter to Argument object.

Field Summary

Fields

Modifier and Type	Field	Description
static FeatureControl	SUPPRESS	The value of FeatureControl.SUPPRESS.

Method Summary

Modifier and Type	Method	Description
static AppendArgumentAction	append()	Returns append action.
static AppendConstArgumentAction	appendConst()	Returns appendConst action.
static CountArgumentAction	count()	Returns count action.
static <T extends java.lang.Enum<T>> EnumArgumentType<T>	enumType(java.lang.Class<T> type)	Returns EnumArgumentType with given enum type.
static FileArgumentType	fileType()	Returns new FileArgumentType object.
static HelpArgumentAction	help()	Returns help action.
static <T extends java.lang.Comparable<T>> RangeArgumentChoice<T>	range(T min, T max)	Creates new range constrained choice.
static StoreArgumentAction	store()	Returns store action.
static StoreConstArgumentAction	storeConst()	Returns storeConst action.
static StoreFalseArgumentAction	storeFalse()	Returns storeFalse action.
static StoreTrueArgumentAction	storeTrue()	Returns storeTrue action.
static VersionArgumentAction	version()	Returns version action.

Methods inherited from class java.lang.Object

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

Field Detail

SUPPRESS

public static final FeatureControl SUPPRESS

The value of FeatureControl.SUPPRESS.

If value is used with Argument.setDefault(FeatureControl), no attribute is added if the command line argument was not present. Otherwise, the default value, which defaults to null, will be added to the object, regardless of the presence of command line argument, returned by ArgumentParser.parseArgs(String[]).

Method Detail

range

public static <T extends java.lang.Comparable<T>> RangeArgumentChoice<T> range(T min,
                                                                               T max)

Creates new range constrained choice.

The value specified in command line will be checked to see whether it fits in given range [min, max], inclusive.

Parameters:

min - The lowerbound of the range, inclusive.

max - The upperbound of the range, inclusive.

Returns:

RangeArgumentChoice object.

store

public static StoreArgumentAction store()

Returns store action.

Returns:

StoreArgumentAction object.

storeTrue

public static StoreTrueArgumentAction storeTrue()

Returns storeTrue action.

If this action is used, the value specified using Argument.nargs(int) will be ignored.

Returns:

StoreTrueArgumentAction object.

storeFalse

public static StoreFalseArgumentAction storeFalse()

Returns storeFalse action.

If this action is used, the value specified using Argument.nargs(int) will be ignored.

Returns:

StoreFalseArgumentAction object.

storeConst

public static StoreConstArgumentAction storeConst()

Returns storeConst action.

If this action is used, the value specified using Argument.nargs(int) will be ignored.

Returns:

StoreConstArgumentAction object.

append

public static AppendArgumentAction append()

Returns append action.

If this action is used, the attribute will be of type List. If used with Argument.nargs(int), the element of List will be List. This is because Argument.nargs(int) produces List.

Returns:

AppendArgumentAction object.

appendConst

public static AppendConstArgumentAction appendConst()

Returns appendConst action.

If this action is used, the value specified using Argument.nargs(int) will be ignored.

Returns:

AppendConstArgumentAction object.

help

public static HelpArgumentAction help()

Returns help action.

This is used for an option printing help message. Please note that this action terminates program after printing help message.

Returns:

HelpArgumentAction object.

version

public static VersionArgumentAction version()

Returns version action.

This is used for an option printing version message. Please note that this action terminates program after printing version message.

Returns:

VersionArgumentAction object.

count

public static CountArgumentAction count()

Returns count action.

This action counts the number of occurrence of the option. This action does not consume argument.

Returns:

CountArgumentAction object.

enumType

public static <T extends java.lang.Enum<T>> EnumArgumentType<T> enumType(java.lang.Class<T> type)

Returns EnumArgumentType with given enum type.

Since enum does not have a constructor with string argument, you cannot use Argument.type(Class). Instead use this convenient function.

Parameters:

type - The enum type

Returns:

EnumArgumentType object

fileType

public static FileArgumentType fileType()

Returns new FileArgumentType object.

Returns:

FileArgumentType object