DocumentListItem Class

Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.0-beta.4
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.DocumentListItem

Implements

JsonSerializable<DocumentListItem>

public final class DocumentListItem
implements JsonSerializable<DocumentListItem>

An object representing a list item in the document.

Method Summary

Modifier and Type Method and Description
static DocumentListItem fromJson(JsonReader jsonReader)

Reads an instance of DocumentListItem from the JsonReader.
List<BoundingRegion> getBoundingRegions()

Get the boundingRegions property: Bounding regions covering the list item.
String getContent()

Get the content property: Content of the list item.
List<String> getElements()

Get the elements property: Child elements of the list item.
int getLevel()

Get the level property: Level of the list item (1-indexed).
List<DocumentSpan> getSpans()

Get the spans property: Location of the list item in the reading order concatenated content.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static DocumentListItem fromJson(JsonReader jsonReader)

Reads an instance of DocumentListItem from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getBoundingRegions

public List<BoundingRegion> getBoundingRegions()

Get the boundingRegions property: Bounding regions covering the list item.

Returns:

the boundingRegions value.

getContent

public String getContent()

Get the content property: Content of the list item.

Returns:

the content value.

getElements

public List<String> getElements()

Get the elements property: Child elements of the list item.

Returns:

the elements value.

getLevel

public int getLevel()

Get the level property: Level of the list item (1-indexed).

Returns:

the level value.

getSpans

public List<DocumentSpan> getSpans()

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

Returns:

the spans value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to