Package org.springframework.shell.command

Enum Class CommandRegistration.OptionArity

java.lang.Object

java.lang.Enum<CommandRegistration.OptionArity>

org.springframework.shell.command.CommandRegistration.OptionArity

All Implemented Interfaces:

Serializable, Comparable<CommandRegistration.OptionArity>, Constable

Enclosing interface:

CommandRegistration

public static enum CommandRegistration.OptionArity
extends Enum<CommandRegistration.OptionArity>

Enumeration of option arity values.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXACTLY_ONE	Define min(1), max(1).
NONE	Used to indicate that arity is not set.
ONE_OR_MORE	Define min(1), max(MAXINTEGER).
ZERO	Define min(0), max(0).
ZERO_OR_MORE	Define min(0), max(MAXINTEGER).
ZERO_OR_ONE	Define min(0), max(1).

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final CommandRegistration.OptionArity NONE

Used to indicate that arity is not set. Exists as a workaround for a case where it's not possible to use null values.

ZERO

public static final CommandRegistration.OptionArity ZERO

Define min(0), max(0).

ZERO_OR_ONE

public static final CommandRegistration.OptionArity ZERO_OR_ONE

Define min(0), max(1).

EXACTLY_ONE

public static final CommandRegistration.OptionArity EXACTLY_ONE

Define min(1), max(1).

ZERO_OR_MORE

public static final CommandRegistration.OptionArity ZERO_OR_MORE

Define min(0), max(MAXINTEGER).

ONE_OR_MORE

public static final CommandRegistration.OptionArity ONE_OR_MORE

Define min(1), max(MAXINTEGER).

Method Details

values

public static CommandRegistration.OptionArity[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static CommandRegistration.OptionArity valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null