DocumentList Class

  • java.lang.Object
    • com.azure.ai.documentintelligence.models.DocumentList

Implements

public final class DocumentList
implements JsonSerializable<DocumentList>

An object representing a list in the document.

Method Summary

Modifier and Type Method and Description
static DocumentList fromJson(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.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Method Details

fromJson

public static DocumentList fromJson(JsonReader jsonReader)

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:

IOException

- If the deserialized JSON object was missing any required properties.

getItems

public List<DocumentListItem> getItems()

Get the items property: Items in the list.

Returns:

the items value.

getSpans

public List<DocumentSpan> getSpans()

Get the spans property: Location of the list in the reading order concatenated content.

Returns:

the spans value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to