com.innovatrics.mrz.types

Enum MrzSex

java.lang.Object

java.lang.Enum<MrzSex>

com.innovatrics.mrz.types.MrzSex

All Implemented Interfaces:

Serializable, Comparable<MrzSex>

public enum MrzSex
extends Enum<MrzSex>

MRZ sex.

Author:

Martin Vysny

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEMALE Female MRZ sex type.
MALE Male MRZ sex type.
UNSPECIFIED Unspecified MRZ sex type.

Method Summary

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

Male MRZ sex type.

FEMALE

public static final MrzSex FEMALE

Female MRZ sex type.

UNSPECIFIED

public static final MrzSex UNSPECIFIED

Unspecified MRZ sex type.

Method Detail

values

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

Returns:

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

valueOf

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

getMrz

public final char getMrz()

Returns:

the MRZ character

fromMrz

public static MrzSex fromMrz(char sex)

Parameters:

sex - the sex char

Returns:

the matching MrzSex type