ParagraphRole Class

Package:

com.azure.ai.formrecognizer.documentanalysis.models

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.12

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole

public final class ParagraphRole
extends ExpandableStringEnum<ParagraphRole>

Semantic role of the paragraph.

Field Summary

Modifier and Type	Field and Description
static final ParagraphRole	FOOTNOTE A note usually placed after the main content on a page.
static final ParagraphRole	FORMULA_BLOCK A block of formulas, often with shared alignment.
static final ParagraphRole	PAGE_FOOTER Text near the bottom edge of the page.
static final ParagraphRole	PAGE_HEADER Text near the top edge of the page.
static final ParagraphRole	PAGE_NUMBER Page number.
static final ParagraphRole	SECTION_HEADING Sub heading describing a section of the document.
static final ParagraphRole	TITLE Top-level title describing the entire document.

Constructor Summary

Constructor	Description
ParagraphRole()	Deprecated Use the fromString(String name) factory method. Creates a new instance of ParagraphRole value.

Method Summary

Modifier and Type	Method and 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 ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

FOOTNOTE

public static final ParagraphRole FOOTNOTE

A note usually placed after the main content on a page.

FORMULA_BLOCK

public static final ParagraphRole FORMULA_BLOCK

A block of formulas, often with shared alignment.

PAGE_FOOTER

public static final ParagraphRole PAGE_FOOTER

Text near the bottom edge of the page.

PAGE_HEADER

public static final ParagraphRole PAGE_HEADER

Text near the top edge of the page.

PAGE_NUMBER

public static final ParagraphRole PAGE_NUMBER

Page number.

SECTION_HEADING

public static final ParagraphRole SECTION_HEADING

Sub heading describing a section of the document.

TITLE

public static final ParagraphRole TITLE

Top-level title describing the entire document.

Constructor Details

ParagraphRole

@Deprecated
public ParagraphRole()

Deprecated

Use the fromString(String name) 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 values()

Gets known ParagraphRole values.

Returns:

known ParagraphRole values.