eu.id3.bioseal

## Class BarcodeReader

- java.lang.Object
- - eu.id3.bioseal.BarcodeReader

- All Implemented Interfaces:
    java.io.Serializable, java.lang.AutoCloseable

      public class BarcodeReader
      extends java.lang.Object
      implements java.lang.AutoCloseable, java.io.Serializable

  Provides functionality to decode barcodes from raw image data.
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `BarcodeReader()` Creates a new instance of the BarcodeReader class.
    `BarcodeReader(long handle)` Creates a new instance of the BarcodeReader class.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `close()` Releases all resources used by this BarcodeReader.
    `boolean` | `decode(byte[] data)` Attempts to decode a barcode from the provided raw image data.
    `protected void` | `finalize()` Finalizer for this class.
    `long` | `getHandle()` Gets the native handle.
    `byte[]` | `getOutputData()` Gets the holds the decoded data extracted from the barcode.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### BarcodeReader

          public BarcodeReader()
                        throws BiosealException

      Creates a new instance of the BarcodeReader class.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### BarcodeReader

          public BarcodeReader(long handle)
                        throws BiosealException

      Creates a new instance of the BarcodeReader class.
      Parameters:
        `handle` - Handle to the BarcodeReader.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

  - ### Method Detail

    - #### close

          public void close()

      Releases all resources used by this BarcodeReader.
      Specified by:
        `close` in interface `java.lang.AutoCloseable`

    - #### finalize

          protected void finalize()

      Finalizer for this class. Finalizers are deprecated since Java 9+. This method is not guaranteed to be called. To release all memory held by this class please be sure to call the close() method.
      Overrides:
        `finalize` in class `java.lang.Object`

    - #### getHandle

          public long getHandle()

      Gets the native handle.
      Returns:
        The native handle.

    - #### getOutputData

          public byte[] getOutputData()
                               throws BiosealException

      Gets the holds the decoded data extracted from the barcode.
      Returns:
        Holds the decoded data extracted from the barcode.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

    - #### decode

          public boolean decode(byte[] data)
                         throws BiosealException

      Attempts to decode a barcode from the provided raw image data.
      Parameters:
        `data` - An array of bytes representing the raw image data that contains the barcode to be decoded.
      Returns:
        A boolean output that indicates the success of the decoding process. It is set to 'true' if the barcode is successfully decoded, otherwise 'false'.
      Throws:
        `BiosealException` - An error has occurred during Bioseal Library execution.

Copyright © 2020-2030, id3 Technologies. All rights reserved. eu.id3.bioseal