Package eu.tneitzel.rmg.internal

Enum RMGOptionGroup

java.lang.Object

java.lang.Enum<RMGOptionGroup>

eu.tneitzel.rmg.internal.RMGOptionGroup

All Implemented Interfaces:

eu.tneitzel.argparse4j.global.IOptionGroup, Serializable, Comparable<RMGOptionGroup>

public enum RMGOptionGroup
extends Enum<RMGOptionGroup>
implements eu.tneitzel.argparse4j.global.IOptionGroup

The RMGOptionGroup enum is used to bundle certain options into a logical context. The corresponding options can then be displayed within an ArgumentGroup inside of help menus. Arguments that should not be displayed within a separate ArgumentGroup should set the RMGOptionGroup.NONE. Currently, the RMGOptionGroup.ACTION is basically equivalent to RMGOptionGroup.NONE, but this may changes in future.

Author:

Tobias Neitzel (@qtc_de)

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTION	action related arguments
CONNECTION	connection related arguments
GENERAL	general arguments
NONE	no option group
SSRF	SSRF related arguments
TARGET	target related arguments

Method Summary

Modifier and Type	Method	Description
String	getName()
static RMGOptionGroup	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RMGOptionGroup[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SSRF

public static final RMGOptionGroup SSRF

SSRF related arguments

TARGET

public static final RMGOptionGroup TARGET

target related arguments

CONNECTION

public static final RMGOptionGroup CONNECTION

connection related arguments

GENERAL

public static final RMGOptionGroup GENERAL

general arguments

ACTION

public static final RMGOptionGroup ACTION

action related arguments

NONE

public static final RMGOptionGroup NONE

no option group

Method Detail

values

public static RMGOptionGroup[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RMGOptionGroup c : RMGOptionGroup.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RMGOptionGroup valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Specified by:

getName in interface eu.tneitzel.argparse4j.global.IOptionGroup