MrzScannerResult

java.lang.Object

io.scanbot.sdk.mrz.MrzScannerResult

All Implemented Interfaces:: AutoCloseable

public class MrzScannerResult extends Object implements AutoCloseable

Container for result of MRZ scanning attempt.

Constructor Summary

Constructors

Constructor

Description

MrzScannerResult(boolean success, String rawMRZ, GenericDocument document)

Constructs MrzScannerResult with the given params.

MrzScannerResult(String rawMRZ, GenericDocument document)

Constructs MrzScannerResult with default parameters.
Method Summary

Modifier and Type

Method

Description

void

close()

Closes native resources (images) held by the object.

GenericDocument

getDocument()

Getter for document field.

String

getRawMRZ()

Getter for rawMRZ field.

boolean

getSuccess()

Getter for success field.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- MrzScannerResult
  
  public MrzScannerResult(boolean success, String rawMRZ, GenericDocument document)
  
  Constructs MrzScannerResult with the given params.
  
  Parameters:
  
  success - Scanning successful. Default is `false`.
  
  rawMRZ - Raw string value of MRZ.
  
  document - Generic document containing MRZ data.
- MrzScannerResult
  
  public MrzScannerResult(String rawMRZ, GenericDocument document)
  
  Constructs MrzScannerResult with default parameters.
  
  Parameters:
  
  rawMRZ - Raw string value of MRZ.
  
  document - Generic document containing MRZ data.
Method Details
- getSuccess
  
  public boolean getSuccess()
  
  Getter for success field. See constructor documentation for more information about the field.
  
  Returns:
  
  success
- getRawMRZ
  
  public String getRawMRZ()
  
  Getter for rawMRZ field. See constructor documentation for more information about the field.
  
  Returns:
  
  rawMRZ
- getDocument
  
  public GenericDocument getDocument()
  
  Getter for document field. See constructor documentation for more information about the field.
  
  Returns:
  
  document
- close
  
  public void close()
  
  Closes native resources (images) held by the object.
  
  Specified by:
  
  close in interface AutoCloseable