Package com.azure.ai.documentintelligence.models

Class DocumentList

java.lang.Object

com.azure.ai.documentintelligence.models.DocumentList

All Implemented Interfaces:

com.azure.json.JsonSerializable<DocumentList>

public final class DocumentList
extends Object
implements com.azure.json.JsonSerializable<DocumentList>

An object representing a list in the document.

Method Summary

Modifier and Type	Method	Description
static DocumentList	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of DocumentList from the JsonReader.
List<DocumentListItem>	getItems()	Get the items property: Items in the list.
List<DocumentSpan>	getSpans()	Get the spans property: Location of the list 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 list in the reading order concatenated content.

Returns:

the spans value.

getItems

public List<DocumentListItem> getItems()

Get the items property: Items in the list.

Returns:

the items value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<DocumentList>

Throws:

IOException

fromJson

public static DocumentList fromJson(com.azure.json.JsonReader jsonReader)
                             throws IOException

Reads an instance of DocumentList from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentList 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 DocumentList.