MrzParser

java.lang.Object

io.scanbot.sdk.mrz.MrzParser

All Implemented Interfaces:: AutoCloseable

public class MrzParser extends Object implements AutoCloseable

API for machine readable zone parsing. Required licence feature(s): MrzScanner.

Constructor Summary

Constructors

Constructor

Description

MrzParser(MrzParserConfiguration configuration)

Constructs MrzParser with the given params.
Method Summary

Modifier and Type

Method

Description

void

close()

Closes native resources held by the object.

protected void

finalize()

MrzScannerResult

parse(String text)

Parse the MRZ string.

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

Constructor Details
- MrzParser
  
  public MrzParser(MrzParserConfiguration configuration) throws LicenseException
  
  Constructs MrzParser with the given params.
  
  Parameters:
  
  configuration - The configuration to use for the parser.
  
  Throws:
  
  LicenseException - If license requirements for the API are not met
Method Details
- parse
  
  public MrzScannerResult parse(String text) throws InvalidImageRefException, LicenseException
  
  Parse the MRZ string.
  
  Parameters:
  
  text - The MRZ string to parse. Should be formatted with newlines.
  
  Returns:
  
  The recognition result.
  
  Throws:
  
  InvalidImageRefException - If an invalid image reference is used
  
  LicenseException - If license requirements for the API are not met
- close
  
  public void close()
  
  Closes native resources held by the object.
  
  Specified by:
  
  close in interface AutoCloseable
- finalize
  
  protected void finalize() throws Throwable
  
  Overrides:
  
  finalize in class Object
  
  Throws:
  
  Throwable