Package com.azure.ai.documentintelligence.models

Class DocumentSection

java.lang.Object
com.azure.ai.documentintelligence.models.DocumentSection
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentSection>
public final class DocumentSection extends Object implements com.azure.json.JsonSerializable<DocumentSection>
An object representing a section in the document.

  • Method Summary

    Modifier and Type
    Method
    Description
    static DocumentSection
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of DocumentSection from the JsonReader.
    List<String>
    getElements()
    Get the elements property: Child elements of the section.
    List<DocumentSpan>
    getSpans()
    Get the spans property: Location of the section in the reading order concatenated content.
    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

    • getSpans

      public List<DocumentSpan> getSpans()
      Get the spans property: Location of the section in the reading order concatenated content.
      Returns:
      the spans value.

    • getElements

      public List<String> getElements()
      Get the elements property: Child elements of the section.
      Returns:
      the elements value.

    • toJson

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

    • fromJson

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