Package com.helger.commons.state

Enum EMandatory

java.lang.Object

java.lang.Enum<EMandatory>

com.helger.commons.state.EMandatory

All Implemented Interfaces:

IMandatoryIndicator, Serializable, Comparable<EMandatory>

public enum EMandatory
extends Enum<EMandatory>
implements IMandatoryIndicator

Small enum for setter method to identify whether a value is mandatory or not.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant	Description
MANDATORY
OPTIONAL

Method Summary

Modifier and Type	Method	Description
boolean	isMandatory()
static EMandatory	valueOf(boolean bMandatory)	Returns the enum constant of this type with the specified name.
static EMandatory	valueOf(IMandatoryIndicator aMandatoryIndicator)	Returns the enum constant of this type with the specified name.
static EMandatory	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EMandatory[]	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

Methods inherited from interface com.helger.commons.state.IMandatoryIndicator

and, isOptional, or

Enum Constant Detail

MANDATORY

public static final EMandatory MANDATORY

OPTIONAL

public static final EMandatory OPTIONAL

Method Detail

values

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

Returns:

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

valueOf

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

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface IMandatoryIndicator

Returns:

true if mandatory and false if not mandatory.

valueOf

@Nonnull
public static EMandatory valueOf(boolean bMandatory)

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:

bMandatory - 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

valueOf

@Nonnull
public static EMandatory valueOf(@Nonnull
                                 IMandatoryIndicator aMandatoryIndicator)

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:

aMandatoryIndicator - 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