Package eu.webtoolkit.jwt.auth

Enum Class EmailPolicy

java.lang.Object

java.lang.Enum<EmailPolicy>

eu.webtoolkit.jwt.auth.EmailPolicy

All Implemented Interfaces:

Serializable, Comparable<EmailPolicy>, Constable

public enum EmailPolicy
extends Enum<EmailPolicy>

Enumeration for an email policy.

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
Disabled	The email address is not asked for.
Mandatory	A user must provide an email address.
Optional	A user may optionally provide an email address.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Returns the numerical representation of this enum.
static EmailPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EmailPolicy[]	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

Disabled

public static final EmailPolicy Disabled

The email address is not asked for.

Optional

public static final EmailPolicy Optional

A user may optionally provide an email address.

Mandatory

public static final EmailPolicy Mandatory

A user must provide an email address.

Method Details

values

public static EmailPolicy[] 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 EmailPolicy 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

getValue

public int getValue()

Returns the numerical representation of this enum.