de.unkrig.commons.util.annotation

Enum CommandLineOption.Cardinality

java.lang.Object

java.lang.Enum<CommandLineOption.Cardinality>

de.unkrig.commons.util.annotation.CommandLineOption.Cardinality

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CommandLineOption.Cardinality>

Enclosing class:

CommandLineOption

public static enum CommandLineOption.Cardinality
extends java.lang.Enum<CommandLineOption.Cardinality>

See Also:

CommandLineOption.cardinality()

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Indicates that the annotated command line option may appear any number of times.
MANDATORY Indicates that the annotated command line option must appear exactly once.
ONCE_OR_MORE Indicates that the annotated command line option must appear once or multiple times.
OPTIONAL Indicates that the annotated command line option must appear zero times or once.

Method Summary

Modifier and Type	Method and Description
static CommandLineOption.Cardinality	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CommandLineOption.Cardinality[]	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

OPTIONAL

public static final CommandLineOption.Cardinality OPTIONAL

Indicates that the annotated command line option must appear zero times or once.

MANDATORY

public static final CommandLineOption.Cardinality MANDATORY

Indicates that the annotated command line option must appear exactly once.

ONCE_OR_MORE

public static final CommandLineOption.Cardinality ONCE_OR_MORE

Indicates that the annotated command line option must appear once or multiple times.

ANY

public static final CommandLineOption.Cardinality ANY

Indicates that the annotated command line option may appear any number of times.

Method Detail

values

public static CommandLineOption.Cardinality[] 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 (CommandLineOption.Cardinality c : CommandLineOption.Cardinality.values())
    System.out.println(c);

Returns:

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

valueOf

public static CommandLineOption.Cardinality valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null