Package cdc.args

Enum Necessity

java.lang.Object

java.lang.Enum<Necessity>

cdc.args.Necessity

All Implemented Interfaces:

Serializable, Comparable<Necessity>

public enum Necessity
extends Enum<Necessity>

Necessity of an argument.

WARNING: Order of declarations matters.

Author:

D. Carbonne

Enum Constant Summary

Enum Constants

Enum Constant	Description
MANDATORY	The argument is mandatory.
OPTIONAL	The argument is optional.

Method Summary

Modifier and Type	Method	Description
boolean	isWeakerThan(Necessity other)	Returns true if this necessity is weaker than (or equal to) another one.
static Necessity	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Necessity[]	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 Necessity OPTIONAL

The argument is optional.

It can be null.

MANDATORY

public static final Necessity MANDATORY

The argument is mandatory.

It can not be nulL.

Method Detail

values

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

Returns:

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

valueOf

public static Necessity 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

isWeakerThan

public boolean isWeakerThan(Necessity other)

Returns true if this necessity is weaker than (or equal to) another one.

OPTIONAL < MANDATORY

Parameters:

other - The other necessity.

Returns:

true if this necessity is weaker than other.