Class Word.Builder (3.16.0)

public static final class Word.Builder extends GeneratedMessageV3.Builder<Word.Builder> implements WordOrBuilder

A word representation.

Protobuf type google.cloud.vision.v1p1beta1.Word

Implements

WordOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllSymbols(Iterable<? extends Symbol> values)

public Word.Builder addAllSymbols(Iterable<? extends Symbol> values)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addSymbols(Symbol value)

public Word.Builder addSymbols(Symbol value)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Parameter
NameDescription
valueSymbol
Returns
TypeDescription
Word.Builder

addSymbols(Symbol.Builder builderForValue)

public Word.Builder addSymbols(Symbol.Builder builderForValue)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Parameter
NameDescription
builderForValueSymbol.Builder
Returns
TypeDescription
Word.Builder

addSymbols(int index, Symbol value)

public Word.Builder addSymbols(int index, Symbol value)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Parameters
NameDescription
indexint
valueSymbol
Returns
TypeDescription
Word.Builder

addSymbols(int index, Symbol.Builder builderForValue)

public Word.Builder addSymbols(int index, Symbol.Builder builderForValue)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Parameters
NameDescription
indexint
builderForValueSymbol.Builder
Returns
TypeDescription
Word.Builder

addSymbolsBuilder()

public Symbol.Builder addSymbolsBuilder()

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Returns
TypeDescription
Symbol.Builder

addSymbolsBuilder(int index)

public Symbol.Builder addSymbolsBuilder(int index)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Symbol.Builder

build()

public Word build()
Returns
TypeDescription
Word

buildPartial()

public Word buildPartial()
Returns
TypeDescription
Word

clear()

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

clearBoundingBox()

public Word.Builder clearBoundingBox()

The bounding box for the word. 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 vertice order will still be (0, 1, 2, 3).

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

Returns
TypeDescription
Word.Builder

clearConfidence()

public Word.Builder clearConfidence()

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

float confidence = 4;

Returns
TypeDescription
Word.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearProperty()

public Word.Builder clearProperty()

Additional information detected for the word.

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

Returns
TypeDescription
Word.Builder

clearSymbols()

public Word.Builder clearSymbols()

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Returns
TypeDescription
Word.Builder

clone()

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

getBoundingBox()

public BoundingPoly getBoundingBox()

The bounding box for the word. 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 vertice order will still be (0, 1, 2, 3).

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

Returns
TypeDescription
BoundingPoly

The boundingBox.

getBoundingBoxBuilder()

public BoundingPoly.Builder getBoundingBoxBuilder()

The bounding box for the word. 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 vertice order will still be (0, 1, 2, 3).

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

Returns
TypeDescription
BoundingPoly.Builder

getBoundingBoxOrBuilder()

public BoundingPolyOrBuilder getBoundingBoxOrBuilder()

The bounding box for the word. 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 vertice order will still be (0, 1, 2, 3).

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

Returns
TypeDescription
BoundingPolyOrBuilder

getConfidence()

public float getConfidence()

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

float confidence = 4;

Returns
TypeDescription
float

The confidence.

getDefaultInstanceForType()

public Word getDefaultInstanceForType()
Returns
TypeDescription
Word

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getProperty()

public TextAnnotation.TextProperty getProperty()

Additional information detected for the word.

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

Returns
TypeDescription
TextAnnotation.TextProperty

The property.

getPropertyBuilder()

public TextAnnotation.TextProperty.Builder getPropertyBuilder()

Additional information detected for the word.

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

Returns
TypeDescription
TextAnnotation.TextProperty.Builder

getPropertyOrBuilder()

public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()

Additional information detected for the word.

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

Returns
TypeDescription
TextAnnotation.TextPropertyOrBuilder

getSymbols(int index)

public Symbol getSymbols(int index)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Symbol

getSymbolsBuilder(int index)

public Symbol.Builder getSymbolsBuilder(int index)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Symbol.Builder

getSymbolsBuilderList()

public List<Symbol.Builder> getSymbolsBuilderList()

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Returns
TypeDescription
List<Builder>

getSymbolsCount()

public int getSymbolsCount()

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Returns
TypeDescription
int

getSymbolsList()

public List<Symbol> getSymbolsList()

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Returns
TypeDescription
List<Symbol>

getSymbolsOrBuilder(int index)

public SymbolOrBuilder getSymbolsOrBuilder(int index)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
SymbolOrBuilder

getSymbolsOrBuilderList()

public List<? extends SymbolOrBuilder> getSymbolsOrBuilderList()

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Returns
TypeDescription
List<? extends com.google.cloud.vision.v1p1beta1.SymbolOrBuilder>

hasBoundingBox()

public boolean hasBoundingBox()

The bounding box for the word. 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 vertice order will still be (0, 1, 2, 3).

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

Returns
TypeDescription
boolean

Whether the boundingBox field is set.

hasProperty()

public boolean hasProperty()

Additional information detected for the word.

.google.cloud.vision.v1p1beta1.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 Word.Builder mergeBoundingBox(BoundingPoly value)

The bounding box for the word. 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 vertice order will still be (0, 1, 2, 3).

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

Parameter
NameDescription
valueBoundingPoly
Returns
TypeDescription
Word.Builder

mergeFrom(Word other)

public Word.Builder mergeFrom(Word other)
Parameter
NameDescription
otherWord
Returns
TypeDescription
Word.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeProperty(TextAnnotation.TextProperty value)

public Word.Builder mergeProperty(TextAnnotation.TextProperty value)

Additional information detected for the word.

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

Parameter
NameDescription
valueTextAnnotation.TextProperty
Returns
TypeDescription
Word.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeSymbols(int index)

public Word.Builder removeSymbols(int index)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Word.Builder

setBoundingBox(BoundingPoly value)

public Word.Builder setBoundingBox(BoundingPoly value)

The bounding box for the word. 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 vertice order will still be (0, 1, 2, 3).

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

Parameter
NameDescription
valueBoundingPoly
Returns
TypeDescription
Word.Builder

setBoundingBox(BoundingPoly.Builder builderForValue)

public Word.Builder setBoundingBox(BoundingPoly.Builder builderForValue)

The bounding box for the word. 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 vertice order will still be (0, 1, 2, 3).

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

Parameter
NameDescription
builderForValueBoundingPoly.Builder
Returns
TypeDescription
Word.Builder

setConfidence(float value)

public Word.Builder setConfidence(float value)

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

float confidence = 4;

Parameter
NameDescription
valuefloat

The confidence to set.

Returns
TypeDescription
Word.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setProperty(TextAnnotation.TextProperty value)

public Word.Builder setProperty(TextAnnotation.TextProperty value)

Additional information detected for the word.

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

Parameter
NameDescription
valueTextAnnotation.TextProperty
Returns
TypeDescription
Word.Builder

setProperty(TextAnnotation.TextProperty.Builder builderForValue)

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

Additional information detected for the word.

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

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

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

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

setSymbols(int index, Symbol value)

public Word.Builder setSymbols(int index, Symbol value)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Parameters
NameDescription
indexint
valueSymbol
Returns
TypeDescription
Word.Builder

setSymbols(int index, Symbol.Builder builderForValue)

public Word.Builder setSymbols(int index, Symbol.Builder builderForValue)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p1beta1.Symbol symbols = 3;

Parameters
NameDescription
indexint
builderForValueSymbol.Builder
Returns
TypeDescription
Word.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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