Field.Builder (lib 1.0.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>
    - - com.google.protobuf.Field.Builder

All Implemented Interfaces:

FieldOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable

Enclosing class:

Field
```
public static final class Field.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>
implements FieldOrBuilder
```
```
 A single field of a message type.
 
```
Protobuf type google.protobuf.Field

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Field.Builder`	`addAllOptions(java.lang.Iterable<? extends Option> values)` The protocol buffer options.
`Field.Builder`	`addOptions(int index, Option.Builder builderForValue)` The protocol buffer options.
`Field.Builder`	`addOptions(int index, Option value)` The protocol buffer options.
`Field.Builder`	`addOptions(Option.Builder builderForValue)` The protocol buffer options.
`Field.Builder`	`addOptions(Option value)` The protocol buffer options.
`Option.Builder`	`addOptionsBuilder()` The protocol buffer options.
`Option.Builder`	`addOptionsBuilder(int index)` The protocol buffer options.
`Field.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`Field`	`build()`
`Field`	`buildPartial()`
`Field.Builder`	`clear()`
`Field.Builder`	`clearCardinality()` The field cardinality.
`Field.Builder`	`clearDefaultValue()` The string value of the default value of this field.
`Field.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Field.Builder`	`clearJsonName()` The field JSON name.
`Field.Builder`	`clearKind()` The field type.
`Field.Builder`	`clearName()` The field name.
`Field.Builder`	`clearNumber()` The field number.
`Field.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Field.Builder`	`clearOneofIndex()` The index of the field type in `Type.oneofs`, for message or enumeration types.
`Field.Builder`	`clearOptions()` The protocol buffer options.
`Field.Builder`	`clearPacked()` Whether to use alternative packed wire representation.
`Field.Builder`	`clearTypeUrl()` The field type URL, without the scheme, for message or enumeration types.
`Field.Builder`	`clone()`
`Field.Cardinality`	`getCardinality()` The field cardinality.
`int`	`getCardinalityValue()` The field cardinality.
`Field`	`getDefaultInstanceForType()`
`java.lang.String`	`getDefaultValue()` The string value of the default value of this field.
`com.google.protobuf.ByteString`	`getDefaultValueBytes()` The string value of the default value of this field.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getJsonName()` The field JSON name.
`com.google.protobuf.ByteString`	`getJsonNameBytes()` The field JSON name.
`Field.Kind`	`getKind()` The field type.
`int`	`getKindValue()` The field type.
`java.lang.String`	`getName()` The field name.
`com.google.protobuf.ByteString`	`getNameBytes()` The field name.
`int`	`getNumber()` The field number.
`int`	`getOneofIndex()` The index of the field type in `Type.oneofs`, for message or enumeration types.
`Option`	`getOptions(int index)` The protocol buffer options.
`Option.Builder`	`getOptionsBuilder(int index)` The protocol buffer options.
`java.util.List<Option.Builder>`	`getOptionsBuilderList()` The protocol buffer options.
`int`	`getOptionsCount()` The protocol buffer options.
`java.util.List<Option>`	`getOptionsList()` The protocol buffer options.
`OptionOrBuilder`	`getOptionsOrBuilder(int index)` The protocol buffer options.
`java.util.List<? extends OptionOrBuilder>`	`getOptionsOrBuilderList()` The protocol buffer options.
`boolean`	`getPacked()` Whether to use alternative packed wire representation.
`java.lang.String`	`getTypeUrl()` The field type URL, without the scheme, for message or enumeration types.
`com.google.protobuf.ByteString`	`getTypeUrlBytes()` The field type URL, without the scheme, for message or enumeration types.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Field.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Field.Builder`	`mergeFrom(Field other)`
`Field.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Field.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Field.Builder`	`removeOptions(int index)` The protocol buffer options.
`Field.Builder`	`setCardinality(Field.Cardinality value)` The field cardinality.
`Field.Builder`	`setCardinalityValue(int value)` The field cardinality.
`Field.Builder`	`setDefaultValue(java.lang.String value)` The string value of the default value of this field.
`Field.Builder`	`setDefaultValueBytes(com.google.protobuf.ByteString value)` The string value of the default value of this field.
`Field.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`Field.Builder`	`setJsonName(java.lang.String value)` The field JSON name.
`Field.Builder`	`setJsonNameBytes(com.google.protobuf.ByteString value)` The field JSON name.
`Field.Builder`	`setKind(Field.Kind value)` The field type.
`Field.Builder`	`setKindValue(int value)` The field type.
`Field.Builder`	`setName(java.lang.String value)` The field name.
`Field.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` The field name.
`Field.Builder`	`setNumber(int value)` The field number.
`Field.Builder`	`setOneofIndex(int value)` The index of the field type in `Type.oneofs`, for message or enumeration types.
`Field.Builder`	`setOptions(int index, Option.Builder builderForValue)` The protocol buffer options.
`Field.Builder`	`setOptions(int index, Option value)` The protocol buffer options.
`Field.Builder`	`setPacked(boolean value)` Whether to use alternative packed wire representation.
`Field.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`Field.Builder`	`setTypeUrl(java.lang.String value)` The field type URL, without the scheme, for message or enumeration types.
`Field.Builder`	`setTypeUrlBytes(com.google.protobuf.ByteString value)` The field type URL, without the scheme, for message or enumeration types.
`Field.Builder`	`setUnknownFields(com.google.protobuf.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

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

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

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

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

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

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

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

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

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

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

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

setField
```
public Field.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                              java.lang.Object value)
```
Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

clearField
```
public Field.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

clearOneof
```
public Field.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

setRepeatedField

public Field.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      int index,
                                      java.lang.Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

addRepeatedField
```
public Field.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      java.lang.Object value)
```
Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

mergeFrom
```
public Field.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Field.Builder>

mergeFrom

public Field.Builder mergeFrom(Field other)

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

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

mergeFrom
```
public Field.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Field.Builder>

Throws:

java.io.IOException

getKindValue
```
public int getKindValue()
```
```
 The field type.
 
```
.google.protobuf.Field.Kind kind = 1;
Specified by:

getKindValue in interface FieldOrBuilder

setKindValue

public Field.Builder setKindValue(int value)

 The field type.

.google.protobuf.Field.Kind kind = 1;

getKind
```
public Field.Kind getKind()
```
```
 The field type.
 
```
.google.protobuf.Field.Kind kind = 1;
Specified by:

getKind in interface FieldOrBuilder

setKind

public Field.Builder setKind(Field.Kind value)

 The field type.

.google.protobuf.Field.Kind kind = 1;

clearKind

public Field.Builder clearKind()

 The field type.

.google.protobuf.Field.Kind kind = 1;

getCardinalityValue
```
public int getCardinalityValue()
```
```
 The field cardinality.
 
```
.google.protobuf.Field.Cardinality cardinality = 2;
Specified by:

getCardinalityValue in interface FieldOrBuilder

setCardinalityValue

public Field.Builder setCardinalityValue(int value)

 The field cardinality.

.google.protobuf.Field.Cardinality cardinality = 2;

getCardinality
```
public Field.Cardinality getCardinality()
```
```
 The field cardinality.
 
```
.google.protobuf.Field.Cardinality cardinality = 2;
Specified by:

getCardinality in interface FieldOrBuilder

setCardinality

public Field.Builder setCardinality(Field.Cardinality value)

 The field cardinality.

.google.protobuf.Field.Cardinality cardinality = 2;

clearCardinality

public Field.Builder clearCardinality()

 The field cardinality.

.google.protobuf.Field.Cardinality cardinality = 2;

getNumber
```
public int getNumber()
```
```
 The field number.
 
```
int32 number = 3;
Specified by:

getNumber in interface FieldOrBuilder

setNumber

public Field.Builder setNumber(int value)

 The field number.

int32 number = 3;

clearNumber

public Field.Builder clearNumber()

 The field number.

int32 number = 3;

getName
```
public java.lang.String getName()
```
```
 The field name.
 
```
string name = 4;
Specified by:

getName in interface FieldOrBuilder

getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 The field name.
 
```
string name = 4;
Specified by:

getNameBytes in interface FieldOrBuilder

setName

public Field.Builder setName(java.lang.String value)

 The field name.

string name = 4;

clearName

public Field.Builder clearName()

 The field name.

string name = 4;

setNameBytes

public Field.Builder setNameBytes(com.google.protobuf.ByteString value)

 The field name.

string name = 4;

getTypeUrl

public java.lang.String getTypeUrl()

 The field type URL, without the scheme, for message or enumeration
 types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

string type_url = 6;

Specified by:: getTypeUrl in interface FieldOrBuilder

getTypeUrlBytes

public com.google.protobuf.ByteString getTypeUrlBytes()

 The field type URL, without the scheme, for message or enumeration
 types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

string type_url = 6;

Specified by:: getTypeUrlBytes in interface FieldOrBuilder

setTypeUrl

public Field.Builder setTypeUrl(java.lang.String value)

 The field type URL, without the scheme, for message or enumeration
 types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

string type_url = 6;

clearTypeUrl

public Field.Builder clearTypeUrl()

 The field type URL, without the scheme, for message or enumeration
 types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

string type_url = 6;

setTypeUrlBytes

public Field.Builder setTypeUrlBytes(com.google.protobuf.ByteString value)

 The field type URL, without the scheme, for message or enumeration
 types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

string type_url = 6;

getOneofIndex

public int getOneofIndex()

 The index of the field type in `Type.oneofs`, for message or enumeration
 types. The first type has index 1; zero means the type is not in the list.

int32 oneof_index = 7;

Specified by:: getOneofIndex in interface FieldOrBuilder

setOneofIndex

public Field.Builder setOneofIndex(int value)

 The index of the field type in `Type.oneofs`, for message or enumeration
 types. The first type has index 1; zero means the type is not in the list.

int32 oneof_index = 7;

clearOneofIndex

public Field.Builder clearOneofIndex()

 The index of the field type in `Type.oneofs`, for message or enumeration
 types. The first type has index 1; zero means the type is not in the list.

int32 oneof_index = 7;

getPacked

public boolean getPacked()

 Whether to use alternative packed wire representation.

bool packed = 8;

Specified by:: getPacked in interface FieldOrBuilder

setPacked

public Field.Builder setPacked(boolean value)

 Whether to use alternative packed wire representation.

bool packed = 8;

clearPacked

public Field.Builder clearPacked()

 Whether to use alternative packed wire representation.

bool packed = 8;

getOptionsList
```
public java.util.List<Option> getOptionsList()
```
```
 The protocol buffer options.
 
```
repeated .google.protobuf.Option options = 9;
Specified by:

getOptionsList in interface FieldOrBuilder

getOptionsCount
```
public int getOptionsCount()
```
```
 The protocol buffer options.
 
```
repeated .google.protobuf.Option options = 9;
Specified by:

getOptionsCount in interface FieldOrBuilder

getOptions
```
public Option getOptions(int index)
```
```
 The protocol buffer options.
 
```
repeated .google.protobuf.Option options = 9;
Specified by:

getOptions in interface FieldOrBuilder