com.innovatrics.mrz.types

Enum MrzDocumentCode

java.lang.Object

java.lang.Enum<MrzDocumentCode>

com.innovatrics.mrz.types.MrzDocumentCode

All Implemented Interfaces:

Serializable, Comparable<MrzDocumentCode>

public enum MrzDocumentCode
extends Enum<MrzDocumentCode>

Lists all supported MRZ record types (a.k.a. document codes).

Author:

Martin Vysny

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREW_MEMBER Crew member (AC).
MIGRANT
PASSPORT A passport, P or IP. ... maybe Travel Document that is very similar to the passport.
TYPE_A General A type (besides AC).
TYPE_C General type C.
TYPE_I General I type (besides IP).
TYPE_V Type V (Visa).

Method Summary

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

PASSPORT

public static final MrzDocumentCode PASSPORT

A passport, P or IP. ... maybe Travel Document that is very similar to the passport.

TYPE_I

public static final MrzDocumentCode TYPE_I

General I type (besides IP).

TYPE_A

public static final MrzDocumentCode TYPE_A

General A type (besides AC).

CREW_MEMBER

public static final MrzDocumentCode CREW_MEMBER

Crew member (AC).

TYPE_C

public static final MrzDocumentCode TYPE_C

General type C.

TYPE_V

public static final MrzDocumentCode TYPE_V

Type V (Visa).

MIGRANT

public static final MrzDocumentCode MIGRANT

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static MrzDocumentCode parse(String mrz)
                             throws MrzParseException

Parameters:

mrz - the mrz string

Returns:

the mrz document code

Throws:

MrzParseException - could not parse MRZ