Class Paragraph.Builder (3.1.3)

public static final class Paragraph.Builder extends GeneratedMessageV3.Builder<Paragraph.Builder> implements ParagraphOrBuilder

Structural unit of text representing a number of words in certain order.

Protobuf type google.cloud.vision.v1.Paragraph

Implements

ParagraphOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllWords(Iterable<? extends Word> values)

public Paragraph.Builder addAllWords(Iterable<? extends Word> values)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.vision.v1.Word>
Returns
TypeDescription
Paragraph.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Paragraph.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Paragraph.Builder
Overrides

addWords(Word value)

public Paragraph.Builder addWords(Word value)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
NameDescription
valueWord
Returns
TypeDescription
Paragraph.Builder

addWords(Word.Builder builderForValue)

public Paragraph.Builder addWords(Word.Builder builderForValue)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
NameDescription
builderForValueWord.Builder
Returns
TypeDescription
Paragraph.Builder

addWords(int index, Word value)

public Paragraph.Builder addWords(int index, Word value)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameters
NameDescription
indexint
valueWord
Returns
TypeDescription
Paragraph.Builder

addWords(int index, Word.Builder builderForValue)

public Paragraph.Builder addWords(int index, Word.Builder builderForValue)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameters
NameDescription
indexint
builderForValueWord.Builder
Returns
TypeDescription
Paragraph.Builder

addWordsBuilder()

public Word.Builder addWordsBuilder()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
TypeDescription
Word.Builder

addWordsBuilder(int index)

public Word.Builder addWordsBuilder(int index)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Word.Builder

build()

public Paragraph build()
Returns
TypeDescription
Paragraph

buildPartial()

public Paragraph buildPartial()
Returns
TypeDescription
Paragraph

clear()

public Paragraph.Builder clear()
Returns
TypeDescription
Paragraph.Builder
Overrides

clearBoundingBox()

public Paragraph.Builder clearBoundingBox()

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
TypeDescription
Paragraph.Builder

clearConfidence()

public Paragraph.Builder clearConfidence()

Confidence of the OCR results for the paragraph. Range [0, 1].

float confidence = 4;

Returns
TypeDescription
Paragraph.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Paragraph.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Paragraph.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Paragraph.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Paragraph.Builder
Overrides

clearProperty()

public Paragraph.Builder clearProperty()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
TypeDescription
Paragraph.Builder

clearWords()

public Paragraph.Builder clearWords()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
TypeDescription
Paragraph.Builder

clone()

public Paragraph.Builder clone()
Returns
TypeDescription
Paragraph.Builder
Overrides

getBoundingBox()

public BoundingPoly getBoundingBox()

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
TypeDescription
BoundingPoly

The boundingBox.

getBoundingBoxBuilder()

public BoundingPoly.Builder getBoundingBoxBuilder()

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
TypeDescription
BoundingPoly.Builder

getBoundingBoxOrBuilder()

public BoundingPolyOrBuilder getBoundingBoxOrBuilder()

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
TypeDescription
BoundingPolyOrBuilder

getConfidence()

public float getConfidence()

Confidence of the OCR results for the paragraph. Range [0, 1].

float confidence = 4;

Returns
TypeDescription
float

The confidence.

getDefaultInstanceForType()

public Paragraph getDefaultInstanceForType()
Returns
TypeDescription
Paragraph

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getProperty()

public TextAnnotation.TextProperty getProperty()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
TypeDescription
TextAnnotation.TextProperty

The property.

getPropertyBuilder()

public TextAnnotation.TextProperty.Builder getPropertyBuilder()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
TypeDescription
TextAnnotation.TextProperty.Builder

getPropertyOrBuilder()

public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
TypeDescription
TextAnnotation.TextPropertyOrBuilder

getWords(int index)

public Word getWords(int index)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Word

getWordsBuilder(int index)

public Word.Builder getWordsBuilder(int index)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Word.Builder

getWordsBuilderList()

public List<Word.Builder> getWordsBuilderList()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
TypeDescription
List<Builder>

getWordsCount()

public int getWordsCount()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
TypeDescription
int

getWordsList()

public List<Word> getWordsList()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
TypeDescription
List<Word>

getWordsOrBuilder(int index)

public WordOrBuilder getWordsOrBuilder(int index)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
WordOrBuilder

getWordsOrBuilderList()

public List<? extends WordOrBuilder> getWordsOrBuilderList()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
TypeDescription
List<? extends com.google.cloud.vision.v1.WordOrBuilder>

hasBoundingBox()

public boolean hasBoundingBox()

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
TypeDescription
boolean

Whether the boundingBox field is set.

hasProperty()

public boolean hasProperty()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
TypeDescription
boolean

Whether the property field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBoundingBox(BoundingPoly value)

public Paragraph.Builder mergeBoundingBox(BoundingPoly value)

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Parameter
NameDescription
valueBoundingPoly
Returns
TypeDescription
Paragraph.Builder

mergeFrom(Paragraph other)

public Paragraph.Builder mergeFrom(Paragraph other)
Parameter
NameDescription
otherParagraph
Returns
TypeDescription
Paragraph.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Paragraph.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Paragraph.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Paragraph.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Paragraph.Builder
Overrides

mergeProperty(TextAnnotation.TextProperty value)

public Paragraph.Builder mergeProperty(TextAnnotation.TextProperty value)

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Parameter
NameDescription
valueTextAnnotation.TextProperty
Returns
TypeDescription
Paragraph.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Paragraph.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Paragraph.Builder
Overrides

removeWords(int index)

public Paragraph.Builder removeWords(int index)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Paragraph.Builder

setBoundingBox(BoundingPoly value)

public Paragraph.Builder setBoundingBox(BoundingPoly value)

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Parameter
NameDescription
valueBoundingPoly
Returns
TypeDescription
Paragraph.Builder

setBoundingBox(BoundingPoly.Builder builderForValue)

public Paragraph.Builder setBoundingBox(BoundingPoly.Builder builderForValue)

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Parameter
NameDescription
builderForValueBoundingPoly.Builder
Returns
TypeDescription
Paragraph.Builder

setConfidence(float value)

public Paragraph.Builder setConfidence(float value)

Confidence of the OCR results for the paragraph. Range [0, 1].

float confidence = 4;

Parameter
NameDescription
valuefloat

The confidence to set.

Returns
TypeDescription
Paragraph.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Paragraph.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Paragraph.Builder
Overrides

setProperty(TextAnnotation.TextProperty value)

public Paragraph.Builder setProperty(TextAnnotation.TextProperty value)

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Parameter
NameDescription
valueTextAnnotation.TextProperty
Returns
TypeDescription
Paragraph.Builder

setProperty(TextAnnotation.TextProperty.Builder builderForValue)

public Paragraph.Builder setProperty(TextAnnotation.TextProperty.Builder builderForValue)

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Parameter
NameDescription
builderForValueTextAnnotation.TextProperty.Builder
Returns
TypeDescription
Paragraph.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Paragraph.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Paragraph.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Paragraph.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Paragraph.Builder
Overrides

setWords(int index, Word value)

public Paragraph.Builder setWords(int index, Word value)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameters
NameDescription
indexint
valueWord
Returns
TypeDescription
Paragraph.Builder

setWords(int index, Word.Builder builderForValue)

public Paragraph.Builder setWords(int index, Word.Builder builderForValue)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameters
NameDescription
indexint
builderForValueWord.Builder
Returns
TypeDescription
Paragraph.Builder