io.scanbot.mrzscanner.model

Class MRZCheckDigit

io.scanbot.mrzscanner.model.MRZCheckDigit

public class MRZCheckDigit

MRZ check digit information.

Field Detail

checkDigitCharacter

@JvmField
public byte checkDigitCharacter

Raw check digit character.

successfullyValidated

@JvmField
public boolean successfullyValidated

Check digit validation result.

type

@JvmField
 @NotNull
public MRZCheckDigitType type

Check digit type.

validatedString

@JvmField
 @NotNull
public java.lang.String validatedString

Text string for this checkdigit validation.

Companion

public static io.scanbot.mrzscanner.model.MRZCheckDigit.Companion Companion

Constructor Detail

MRZCheckDigit

public MRZCheckDigit(byte checkDigitCharacter,
                     boolean successfullyValidated,
                     @NotNull
                     MRZCheckDigitType type,
                     @NotNull
                     java.lang.String validatedString)

MRZ check digit information.

Parameters:

checkDigitCharacter - Raw check digit character.

successfullyValidated - Check digit validation result.

type - Check digit type.

validatedString - Text string for this checkdigit validation.

MRZCheckDigit

public MRZCheckDigit(byte checkDigitCharacter,
                     boolean successfullyValidated,
                     int type,
                     @NotNull
                     java.lang.String validatedString)

Method Detail

intValueFromMRZCheckDigitType

protected int intValueFromMRZCheckDigitType()

component1

public byte component1()

Raw check digit character.

component2

public boolean component2()

Check digit validation result.

component3

@NotNull
public MRZCheckDigitType component3()

Check digit type.

component4

@NotNull
public java.lang.String component4()

Text string for this checkdigit validation.

copy

@NotNull
public MRZCheckDigit copy(byte checkDigitCharacter,
                                   boolean successfullyValidated,
                                   @NotNull
                                   MRZCheckDigitType type,
                                   @NotNull
                                   java.lang.String validatedString)

MRZ check digit information.

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)