org.pac4j.core.profile

Enum Gender

java.lang.Object

java.lang.Enum<Gender>

org.pac4j.core.profile.Gender

All Implemented Interfaces:

Serializable, Comparable<Gender>

public enum Gender
extends Enum<Gender>

This enumeration is the gender of a user : male, female or unspecified.

Since:

1.0.0

Author:

Jerome Leleu

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEMALE
MALE
UNSPECIFIED

Method Summary

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

MALE

public static final Gender MALE

FEMALE

public static final Gender FEMALE

UNSPECIFIED

public static final Gender UNSPECIFIED

Method Detail

values

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

Returns:

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

valueOf

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