Package com.azure.ai.formrecognizer.documentanalysis.models

Class ParagraphRole

java.lang.Object

com.azure.core.util.ExpandableStringEnum<ParagraphRole>

com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole

public final class ParagraphRole
extends com.azure.core.util.ExpandableStringEnum<ParagraphRole>

Semantic role of the paragraph.

Field Summary

Fields

Modifier and Type	Field	Description
static final ParagraphRole	FOOTNOTE	Static value footnote for ParagraphRole.
static final ParagraphRole	FORMULA_BLOCK	Static value formulaBlock for ParagraphRole.
static final ParagraphRole	PAGE_FOOTER	Static value pageFooter for ParagraphRole.
static final ParagraphRole	PAGE_HEADER	Static value pageHeader for ParagraphRole.
static final ParagraphRole	PAGE_NUMBER	Static value pageNumber for ParagraphRole.
static final ParagraphRole	SECTION_HEADING	Static value sectionHeading for ParagraphRole.
static final ParagraphRole	TITLE	Static value title for ParagraphRole.

Constructor Summary

Constructors

Constructor	Description
ParagraphRole()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static ParagraphRole	fromString(String name)	Creates or finds a ParagraphRole from its string representation.
static Collection<ParagraphRole>	values()	Gets known ParagraphRole values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PAGE_HEADER

public static final ParagraphRole PAGE_HEADER

Static value pageHeader for ParagraphRole.

PAGE_FOOTER

public static final ParagraphRole PAGE_FOOTER

Static value pageFooter for ParagraphRole.

PAGE_NUMBER

public static final ParagraphRole PAGE_NUMBER

Static value pageNumber for ParagraphRole.

TITLE

public static final ParagraphRole TITLE

Static value title for ParagraphRole.

SECTION_HEADING

public static final ParagraphRole SECTION_HEADING

Static value sectionHeading for ParagraphRole.

FOOTNOTE

public static final ParagraphRole FOOTNOTE

Static value footnote for ParagraphRole.

FORMULA_BLOCK

public static final ParagraphRole FORMULA_BLOCK

Static value formulaBlock for ParagraphRole.

Constructor Details

ParagraphRole

@Deprecated
public ParagraphRole()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ParagraphRole value.

Method Details

fromString

public static ParagraphRole fromString(String name)

Creates or finds a ParagraphRole from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ParagraphRole.

values

public static Collection<ParagraphRole> values()

Gets known ParagraphRole values.

Returns:

known ParagraphRole values.