Package com.azure.ai.documentintelligence.models

Class DocumentBarcode

java.lang.Object
com.azure.ai.documentintelligence.models.DocumentBarcode
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentBarcode>
public final class DocumentBarcode extends Object implements com.azure.json.JsonSerializable<DocumentBarcode>
A barcode object.

  • Method Summary

    Modifier and Type
    Method
    Description
    static DocumentBarcode
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of DocumentBarcode from the JsonReader.
    double
    getConfidence()
    Get the confidence property: Confidence of correctly extracting the barcode.
    DocumentBarcodeKind
    getKind()
    Get the kind property: Barcode kind.
    List<Double>
    getPolygon()
    Get the polygon property: Bounding polygon of the barcode, with coordinates specified relative to the top-left of the page.
    DocumentSpan
    getSpan()
    Get the span property: Location of the barcode in the reading order concatenated content.
    String
    getValue()
    Get the value property: Barcode value.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Method Details

    • getKind

      public DocumentBarcodeKind getKind()
      Get the kind property: Barcode kind.
      Returns:
      the kind value.

    • getValue

      public String getValue()
      Get the value property: Barcode value.
      Returns:
      the value value.

    • getPolygon

      public List<Double> getPolygon()
      Get the polygon property: Bounding polygon of the barcode, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation.
      Returns:
      the polygon value.

    • getSpan

      public DocumentSpan getSpan()
      Get the span property: Location of the barcode in the reading order concatenated content.
      Returns:
      the span value.

    • getConfidence

      public double getConfidence()
      Get the confidence property: Confidence of correctly extracting the barcode.
      Returns:
      the confidence value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<DocumentBarcode>
      Throws:
      IOException

    • fromJson

      public static DocumentBarcode fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DocumentBarcode from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DocumentBarcode if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the DocumentBarcode.