Word.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Word.Builder>
    - - com.google.cloud.vision.v1.Word.Builder

All Implemented Interfaces:

WordOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:

Word
```
public static final class Word.Builder
extends GeneratedMessageV3.Builder<Word.Builder>
implements WordOrBuilder
```
```
 A word representation.
 
```
Protobuf type google.cloud.vision.v1.Word

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`Word.Builder`	`clear` Additional information detected for the word.
`boolean`	`has` Additional information detected for the word.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Word.Builder`	`addAllSymbols(java.lang.Iterable<? extends Symbol> values)` List of symbols in the word.
`Word.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`Word.Builder`	`addSymbols(int index, Symbol.Builder builderForValue)` List of symbols in the word.
`Word.Builder`	`addSymbols(int index, Symbol value)` List of symbols in the word.
`Word.Builder`	`addSymbols(Symbol.Builder builderForValue)` List of symbols in the word.
`Word.Builder`	`addSymbols(Symbol value)` List of symbols in the word.
`Symbol.Builder`	`addSymbolsBuilder()` List of symbols in the word.
`Symbol.Builder`	`addSymbolsBuilder(int index)` List of symbols in the word.
`Word`	`build()`
`Word`	`buildPartial()`
`Word.Builder`	`clear()`
`Word.Builder`	`clearBoundingBox()` The bounding box for the word.
`Word.Builder`	`clearConfidence()` Confidence of the OCR results for the word.
`Word.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`Word.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`Word.Builder`	`clearProperty()` Additional information detected for the word.
`Word.Builder`	`clearSymbols()` List of symbols in the word.
`Word.Builder`	`clone()`
`BoundingPoly`	`getBoundingBox()` The bounding box for the word.
`BoundingPoly.Builder`	`getBoundingBoxBuilder()` The bounding box for the word.
`BoundingPolyOrBuilder`	`getBoundingBoxOrBuilder()` The bounding box for the word.
`float`	`getConfidence()` Confidence of the OCR results for the word.
`Word`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`TextAnnotation.TextProperty`	`getProperty()` Additional information detected for the word.
`TextAnnotation.TextProperty.Builder`	`getPropertyBuilder()` Additional information detected for the word.
`TextAnnotation.TextPropertyOrBuilder`	`getPropertyOrBuilder()` Additional information detected for the word.
`Symbol`	`getSymbols(int index)` List of symbols in the word.
`Symbol.Builder`	`getSymbolsBuilder(int index)` List of symbols in the word.
`java.util.List<Symbol.Builder>`	`getSymbolsBuilderList()` List of symbols in the word.
`int`	`getSymbolsCount()` List of symbols in the word.
`java.util.List<Symbol>`	`getSymbolsList()` List of symbols in the word.
`SymbolOrBuilder`	`getSymbolsOrBuilder(int index)` List of symbols in the word.
`java.util.List<? extends SymbolOrBuilder>`	`getSymbolsOrBuilderList()` List of symbols in the word.
`boolean`	`hasBoundingBox()` The bounding box for the word.
`boolean`	`hasProperty()` Additional information detected for the word.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Word.Builder`	`mergeBoundingBox(BoundingPoly value)` The bounding box for the word.
`Word.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`Word.Builder`	`mergeFrom(Message other)`
`Word.Builder`	`mergeFrom(Word other)`
`Word.Builder`	`mergeProperty(TextAnnotation.TextProperty value)` Additional information detected for the word.
`Word.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`Word.Builder`	`removeSymbols(int index)` List of symbols in the word.
`Word.Builder`	`setBoundingBox(BoundingPoly.Builder builderForValue)` The bounding box for the word.
`Word.Builder`	`setBoundingBox(BoundingPoly value)` The bounding box for the word.
`Word.Builder`	`setConfidence(float value)` Confidence of the OCR results for the word.
`Word.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`Word.Builder`	`setProperty(TextAnnotation.TextProperty.Builder builderForValue)` Additional information detected for the word.
`Word.Builder`	`setProperty(TextAnnotation.TextProperty value)` Additional information detected for the word.
`Word.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`Word.Builder`	`setSymbols(int index, Symbol.Builder builderForValue)` List of symbols in the word.
`Word.Builder`	`setSymbols(int index, Symbol value)` List of symbols in the word.
`Word.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Property Detail
- has
```
public boolean hasProperty
```
```
 Additional information detected for the word.
 
```
  .google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;
  Specified by:
  
  hasProperty in interface WordOrBuilder
- clear
```
public Word.Builder clearProperty
```
```
 Additional information detected for the word.
 
```
  .google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Word.Builder>

clear
```
public Word.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<Word.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<Word.Builder>

getDefaultInstanceForType
```
public Word getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public Word build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public Word buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public Word.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<Word.Builder>

setField

public Word.Builder setField(Descriptors.FieldDescriptor field,
                             java.lang.Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<Word.Builder>

clearField
```
public Word.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<Word.Builder>

clearOneof
```
public Word.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<Word.Builder>

setRepeatedField

public Word.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                     int index,
                                     java.lang.Object value)

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<Word.Builder>

addRepeatedField
```
public Word.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                     java.lang.Object value)
```
Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<Word.Builder>

mergeFrom
```
public Word.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Word.Builder>

mergeFrom

public Word.Builder mergeFrom(Word other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<Word.Builder>

mergeFrom

public Word.Builder mergeFrom(CodedInputStream input,
                              ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<Word.Builder>
Throws:: java.io.IOException

hasProperty
```
public boolean hasProperty()
```
```
 Additional information detected for the word.
 
```
.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;
Specified by:

hasProperty in interface WordOrBuilder

getProperty
```
public TextAnnotation.TextProperty getProperty()
```
```
 Additional information detected for the word.
 
```
.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;
Specified by:

getProperty in interface WordOrBuilder

setProperty

public Word.Builder setProperty(TextAnnotation.TextProperty value)

 Additional information detected for the word.

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

setProperty

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

 Additional information detected for the word.

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

mergeProperty

public Word.Builder mergeProperty(TextAnnotation.TextProperty value)

 Additional information detected for the word.

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

clearProperty

public Word.Builder clearProperty()

 Additional information detected for the word.

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

getPropertyBuilder

public TextAnnotation.TextProperty.Builder getPropertyBuilder()

 Additional information detected for the word.

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

getPropertyOrBuilder
```
public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()
```
```
 Additional information detected for the word.
 
```
.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;
Specified by:

getPropertyOrBuilder in interface WordOrBuilder

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.v1.BoundingPoly bounding_box = 2;

Specified by:: hasBoundingBox in interface WordOrBuilder

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.v1.BoundingPoly bounding_box = 2;

Specified by:: getBoundingBox in interface WordOrBuilder

setBoundingBox

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.v1.BoundingPoly bounding_box = 2;

setBoundingBox

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.v1.BoundingPoly bounding_box = 2;

mergeBoundingBox

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.v1.BoundingPoly bounding_box = 2;

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.v1.BoundingPoly bounding_box = 2;

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.v1.BoundingPoly bounding_box = 2;

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.v1.BoundingPoly bounding_box = 2;

Specified by:: getBoundingBoxOrBuilder in interface WordOrBuilder