Package io.scanbot.sdk.mrz

Class MrzScannerResult

  • All Implemented Interfaces:
    java.lang.AutoCloseable
    public class MrzScannerResult
extends java.lang.Object
implements java.lang.AutoCloseable
    Container for result of MRZ scanning attempt.

    • Constructor Summary

      Constructors 
      Constructor Description
      MrzScannerResult​(boolean success, java.lang.String rawMRZ, GenericDocument document)
      Constructs MrzScannerResult with the given params.
      MrzScannerResult​(java.lang.String rawMRZ, GenericDocument document)
      Constructs MrzScannerResult with default parameters.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Closes native resources (images) held by the object.
      GenericDocument getDocument()
      Getter for document field.
      java.lang.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 Detail

      • MrzScannerResult

        public MrzScannerResult​(boolean success,
                        java.lang.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​(java.lang.String rawMRZ,
                        GenericDocument document)
        Constructs MrzScannerResult with default parameters.
        Parameters:
        rawMRZ - Raw string value of MRZ.
        document - Generic document containing MRZ data.

    • Method Detail

      • getSuccess

        public boolean getSuccess()
        Getter for success field. See constructor documentation for more information about the field.
        Returns:
        success

      • getRawMRZ

        public java.lang.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 java.lang.AutoCloseable