Package com.azure.ai.documentintelligence.models

Class DocumentSpan

java.lang.Object
com.azure.ai.documentintelligence.models.DocumentSpan
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentSpan>
public final class DocumentSpan extends Object implements com.azure.json.JsonSerializable<DocumentSpan>
Contiguous region of the concatenated content property, specified as an offset and length.

  • Method Summary

    Modifier and Type
    Method
    Description
    static DocumentSpan
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of DocumentSpan from the JsonReader.
    int
    getLength()
    Get the length property: Number of characters in the content represented by the span.
    int
    getOffset()
    Get the offset property: Zero-based index of the content represented by the span.
    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

    • getOffset

      public int getOffset()
      Get the offset property: Zero-based index of the content represented by the span.
      Returns:
      the offset value.

    • getLength

      public int getLength()
      Get the length property: Number of characters in the content represented by the span.
      Returns:
      the length value.

    • toJson

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

    • fromJson

      public static DocumentSpan fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DocumentSpan from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DocumentSpan 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 DocumentSpan.