Field.Builder (Protocol Buffer Java API 3.0.0-alpha-3 API)

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

All Implemented Interfaces:

FieldOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Enclosing class:

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

Method Summary

Methods
Modifier and Type	Method and Description
`Field.Builder`	`addAllOptions(Iterable<? extends Option> values)` `repeated .google.protobuf.Option options = 9;`
`Field.Builder`	`addOptions(int index, Option.Builder builderForValue)` `repeated .google.protobuf.Option options = 9;`
`Field.Builder`	`addOptions(int index, Option value)` `repeated .google.protobuf.Option options = 9;`
`Field.Builder`	`addOptions(Option.Builder builderForValue)` `repeated .google.protobuf.Option options = 9;`
`Field.Builder`	`addOptions(Option value)` `repeated .google.protobuf.Option options = 9;`
`Option.Builder`	`addOptionsBuilder()` `repeated .google.protobuf.Option options = 9;`
`Option.Builder`	`addOptionsBuilder(int index)` `repeated .google.protobuf.Option options = 9;`
`Field`	`build()` Constructs the message based on the state of the Builder.
`Field`	`buildPartial()` Like `MessageLite.Builder.build()`, but does not throw an exception if the message is missing required fields.
`Field.Builder`	`clear()` Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
`Field.Builder`	`clearCardinality()` `optional .google.protobuf.Field.Cardinality cardinality = 2;`
`Field.Builder`	`clearKind()` `optional .google.protobuf.Field.Kind kind = 1;`
`Field.Builder`	`clearName()` `optional string name = 4;`
`Field.Builder`	`clearNumber()` `optional int32 number = 3;`
`Field.Builder`	`clearOneofIndex()` `optional int32 oneof_index = 7;`
`Field.Builder`	`clearOptions()` `repeated .google.protobuf.Option options = 9;`
`Field.Builder`	`clearPacked()` `optional bool packed = 8;`
`Field.Builder`	`clearTypeUrl()` `optional string type_url = 6;`
`Field.Cardinality`	`getCardinality()` `optional .google.protobuf.Field.Cardinality cardinality = 2;`
`int`	`getCardinalityValue()` `optional .google.protobuf.Field.Cardinality cardinality = 2;`
`Field`	`getDefaultInstanceForType()` Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()` Get the message's type's descriptor.
`Field.Kind`	`getKind()` `optional .google.protobuf.Field.Kind kind = 1;`
`int`	`getKindValue()` `optional .google.protobuf.Field.Kind kind = 1;`
`String`	`getName()` `optional string name = 4;`
`ByteString`	`getNameBytes()` `optional string name = 4;`
`int`	`getNumber()` `optional int32 number = 3;`
`int`	`getOneofIndex()` `optional int32 oneof_index = 7;`
`Option`	`getOptions(int index)` `repeated .google.protobuf.Option options = 9;`
`Option.Builder`	`getOptionsBuilder(int index)` `repeated .google.protobuf.Option options = 9;`
`List<Option.Builder>`	`getOptionsBuilderList()` `repeated .google.protobuf.Option options = 9;`
`int`	`getOptionsCount()` `repeated .google.protobuf.Option options = 9;`
`List<Option>`	`getOptionsList()` `repeated .google.protobuf.Option options = 9;`
`OptionOrBuilder`	`getOptionsOrBuilder(int index)` `repeated .google.protobuf.Option options = 9;`
`List<? extends OptionOrBuilder>`	`getOptionsOrBuilderList()` `repeated .google.protobuf.Option options = 9;`
`boolean`	`getPacked()` `optional bool packed = 8;`
`String`	`getTypeUrl()` `optional string type_url = 6;`
`ByteString`	`getTypeUrlBytes()` `optional string type_url = 6;`
`protected GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()` Get the FieldAccessorTable for this type.
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`Field.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)` Like `MessageLite.Builder.mergeFrom(CodedInputStream)`, but also parses extensions.
`Field.Builder`	`mergeFrom(Field other)`
`Field.Builder`	`mergeFrom(Message other)` Merge `other` into the message being built.
`Field.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)` Merge some unknown fields into the `UnknownFieldSet` for this message.
`Field.Builder`	`removeOptions(int index)` `repeated .google.protobuf.Option options = 9;`
`Field.Builder`	`setCardinality(Field.Cardinality value)` `optional .google.protobuf.Field.Cardinality cardinality = 2;`
`Field.Builder`	`setCardinalityValue(int value)` `optional .google.protobuf.Field.Cardinality cardinality = 2;`
`Field.Builder`	`setKind(Field.Kind value)` `optional .google.protobuf.Field.Kind kind = 1;`
`Field.Builder`	`setKindValue(int value)` `optional .google.protobuf.Field.Kind kind = 1;`
`Field.Builder`	`setName(String value)` `optional string name = 4;`
`Field.Builder`	`setNameBytes(ByteString value)` `optional string name = 4;`
`Field.Builder`	`setNumber(int value)` `optional int32 number = 3;`
`Field.Builder`	`setOneofIndex(int value)` `optional int32 oneof_index = 7;`
`Field.Builder`	`setOptions(int index, Option.Builder builderForValue)` `repeated .google.protobuf.Option options = 9;`
`Field.Builder`	`setOptions(int index, Option value)` `repeated .google.protobuf.Option options = 9;`
`Field.Builder`	`setPacked(boolean value)` `optional bool packed = 8;`
`Field.Builder`	`setTypeUrl(String value)` `optional string type_url = 6;`
`Field.Builder`	`setTypeUrlBytes(ByteString value)` `optional string type_url = 6;`
`Field.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)` Set the `UnknownFieldSet` for this message.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField

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

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, 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

- Method Detail
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
    Description copied from class: GeneratedMessage.Builder
    
    Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.
    
    Specified by:
    
    internalGetFieldAccessorTable in class GeneratedMessage.Builder<Field.Builder>
  - clear
```
public Field.Builder clear()
```
    Description copied from class: GeneratedMessage.Builder
    
    Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
    
    Specified by:
    
    clear in interface Message.Builder
    
    Specified by:
    
    clear in interface MessageLite.Builder
    
    Overrides:
    
    clear in class GeneratedMessage.Builder<Field.Builder>
  - getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
    Description copied from interface: Message.Builder
    
    Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().
    
    Specified by:
    
    getDescriptorForType in interface Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class GeneratedMessage.Builder<Field.Builder>
  - getDefaultInstanceForType
```
public Field getDefaultInstanceForType()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageOrBuilder
  - build
```
public Field build()
```
    Description copied from interface: MessageLite.Builder
    
    Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.
    
    Specified by:
    
    build in interface Message.Builder
    
    Specified by:
    
    build in interface MessageLite.Builder
  - buildPartial
```
public Field buildPartial()
```
    Description copied from interface: MessageLite.Builder
    
    Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.
    
    Specified by:
    
    buildPartial in interface Message.Builder
    
    Specified by:
    
    buildPartial in interface MessageLite.Builder
  - mergeFrom
```
public Field.Builder mergeFrom(Message other)
```
    Description copied from interface: Message.Builder
    
    Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()). Merging occurs as follows. For each field:
    * For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
    * For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
    * For repeated fields, the elements in other are concatenated with the elements in this message. This is equivalent to the Message::MergeFrom method in C++.
    
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Overrides:
    
    mergeFrom in class AbstractMessage.Builder<Field.Builder>
  - mergeFrom
```
public Field.Builder mergeFrom(Field other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Returns true if all required fields in the message and all embedded messages are set, false otherwise.
    See also: MessageOrBuilder.getInitializationErrorString()
    
    Specified by:
    
    isInitialized in interface MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class GeneratedMessage.Builder<Field.Builder>
  - mergeFrom
```
public Field.Builder mergeFrom(CodedInputStream input,
                      ExtensionRegistryLite extensionRegistry)
                        throws IOException
```
    Description copied from interface: MessageLite.Builder
    
    Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.
    
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Specified by:
    
    mergeFrom in interface MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class AbstractMessage.Builder<Field.Builder>
    
    Throws:
    
    IOException
  - getKindValue
```
public int getKindValue()
```
    optional .google.protobuf.Field.Kind kind = 1;
```
 The field kind.
 
```
    Specified by:
    
    getKindValue in interface FieldOrBuilder
  - setKindValue
```
public Field.Builder setKindValue(int value)
```
    optional .google.protobuf.Field.Kind kind = 1;
```
 The field kind.
 
```
  - getKind
```
public Field.Kind getKind()
```
    optional .google.protobuf.Field.Kind kind = 1;
```
 The field kind.
 
```
    Specified by:
    
    getKind in interface FieldOrBuilder
  - setKind
```
public Field.Builder setKind(Field.Kind value)
```
    optional .google.protobuf.Field.Kind kind = 1;
```
 The field kind.
 
```
  - clearKind
```
public Field.Builder clearKind()
```
    optional .google.protobuf.Field.Kind kind = 1;
```
 The field kind.
 
```
  - getCardinalityValue
```
public int getCardinalityValue()
```
    optional .google.protobuf.Field.Cardinality cardinality = 2;
```
 The field cardinality, i.e. optional/required/repeated.
 
```
    Specified by:
    
    getCardinalityValue in interface FieldOrBuilder
  - setCardinalityValue
```
public Field.Builder setCardinalityValue(int value)
```
    optional .google.protobuf.Field.Cardinality cardinality = 2;
```
 The field cardinality, i.e. optional/required/repeated.
 
```
  - getCardinality
```
public Field.Cardinality getCardinality()
```
    optional .google.protobuf.Field.Cardinality cardinality = 2;
```
 The field cardinality, i.e. optional/required/repeated.
 
```
    Specified by:
    
    getCardinality in interface FieldOrBuilder
  - setCardinality
```
public Field.Builder setCardinality(Field.Cardinality value)
```
    optional .google.protobuf.Field.Cardinality cardinality = 2;
```
 The field cardinality, i.e. optional/required/repeated.
 
```
  - clearCardinality
```
public Field.Builder clearCardinality()
```
    optional .google.protobuf.Field.Cardinality cardinality = 2;
```
 The field cardinality, i.e. optional/required/repeated.
 
```
  - getNumber
```
public int getNumber()
```
    optional int32 number = 3;
```
 The proto field number.
 
```
    Specified by:
    
    getNumber in interface FieldOrBuilder
  - setNumber
```
public Field.Builder setNumber(int value)
```
    optional int32 number = 3;
```
 The proto field number.
 
```
  - clearNumber
```
public Field.Builder clearNumber()
```
    optional int32 number = 3;
```
 The proto field number.
 
```
  - getName
```
public String getName()
```
    optional string name = 4;
```
 The field name.
 
```
    Specified by:
    
    getName in interface FieldOrBuilder
  - getNameBytes
```
public ByteString getNameBytes()
```
    optional string name = 4;
```
 The field name.
 
```
    Specified by:
    
    getNameBytes in interface FieldOrBuilder
  - setName
```
public Field.Builder setName(String value)
```
    optional string name = 4;
```
 The field name.
 
```
  - clearName
```
public Field.Builder clearName()
```
    optional string name = 4;
```
 The field name.
 
```
  - setNameBytes
```
public Field.Builder setNameBytes(ByteString value)
```
    optional string name = 4;
```
 The field name.
 
```
  - getTypeUrl
```
public String getTypeUrl()
```
    optional string type_url = 6;
```
 The type URL (without the scheme) when the type is MESSAGE or ENUM,
 such as `type.googleapis.com/google.protobuf.Empty`.
 
```
    Specified by:
    
    getTypeUrl in interface FieldOrBuilder
  - getTypeUrlBytes
```
public ByteString getTypeUrlBytes()
```
    optional string type_url = 6;
```
 The type URL (without the scheme) when the type is MESSAGE or ENUM,
 such as `type.googleapis.com/google.protobuf.Empty`.
 
```
    Specified by:
    
    getTypeUrlBytes in interface FieldOrBuilder
  - setTypeUrl
```
public Field.Builder setTypeUrl(String value)
```
    optional string type_url = 6;
```
 The type URL (without the scheme) when the type is MESSAGE or ENUM,
 such as `type.googleapis.com/google.protobuf.Empty`.
 
```
  - clearTypeUrl
```
public Field.Builder clearTypeUrl()
```
    optional string type_url = 6;
```
 The type URL (without the scheme) when the type is MESSAGE or ENUM,
 such as `type.googleapis.com/google.protobuf.Empty`.
 
```
  - setTypeUrlBytes
```
public Field.Builder setTypeUrlBytes(ByteString value)
```
    optional string type_url = 6;
```
 The type URL (without the scheme) when the type is MESSAGE or ENUM,
 such as `type.googleapis.com/google.protobuf.Empty`.
 
```
  - getOneofIndex
```
public int getOneofIndex()
```
    optional int32 oneof_index = 7;
```
 Index in Type.oneofs. Starts at 1. Zero means no oneof mapping.
 
```
    Specified by:
    
    getOneofIndex in interface FieldOrBuilder
  - setOneofIndex
```
public Field.Builder setOneofIndex(int value)
```
    optional int32 oneof_index = 7;
```
 Index in Type.oneofs. Starts at 1. Zero means no oneof mapping.
 
```
  - clearOneofIndex
```
public Field.Builder clearOneofIndex()
```
    optional int32 oneof_index = 7;
```
 Index in Type.oneofs. Starts at 1. Zero means no oneof mapping.
 
```
  - getPacked
```
public boolean getPacked()
```
    optional bool packed = 8;
```
 Whether to use alternative packed wire representation.
 
```
    Specified by:
    
    getPacked in interface FieldOrBuilder
  - setPacked
```
public Field.Builder setPacked(boolean value)
```
    optional bool packed = 8;
```
 Whether to use alternative packed wire representation.
 
```
  - clearPacked
```
public Field.Builder clearPacked()
```
    optional bool packed = 8;
```
 Whether to use alternative packed wire representation.
 
```
  - getOptionsList
```
public List<Option> getOptionsList()
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
    Specified by:
    
    getOptionsList in interface FieldOrBuilder
  - getOptionsCount
```
public int getOptionsCount()
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
    Specified by:
    
    getOptionsCount in interface FieldOrBuilder
  - getOptions
```
public Option getOptions(int index)
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
    Specified by:
    
    getOptions in interface FieldOrBuilder
  - setOptions
```
public Field.Builder setOptions(int index,
                       Option value)
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - setOptions
```
public Field.Builder setOptions(int index,
                       Option.Builder builderForValue)
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - addOptions
```
public Field.Builder addOptions(Option value)
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - addOptions
```
public Field.Builder addOptions(int index,
                       Option value)
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - addOptions
```
public Field.Builder addOptions(Option.Builder builderForValue)
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - addOptions
```
public Field.Builder addOptions(int index,
                       Option.Builder builderForValue)
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - addAllOptions
```
public Field.Builder addAllOptions(Iterable<? extends Option> values)
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - clearOptions
```
public Field.Builder clearOptions()
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - removeOptions
```
public Field.Builder removeOptions(int index)
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - getOptionsBuilder
```
public Option.Builder getOptionsBuilder(int index)
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - getOptionsOrBuilder
```
public OptionOrBuilder getOptionsOrBuilder(int index)
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
    Specified by:
    
    getOptionsOrBuilder in interface FieldOrBuilder
  - getOptionsOrBuilderList
```
public List<? extends OptionOrBuilder> getOptionsOrBuilderList()
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
    Specified by:
    
    getOptionsOrBuilderList in interface FieldOrBuilder
  - addOptionsBuilder
```
public Option.Builder addOptionsBuilder()
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - addOptionsBuilder
```
public Option.Builder addOptionsBuilder(int index)
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - getOptionsBuilderList
```
public List<Option.Builder> getOptionsBuilderList()
```
    repeated .google.protobuf.Option options = 9;
```
 The proto options.
 
```
  - setUnknownFields
```
public final Field.Builder setUnknownFields(UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Set the UnknownFieldSet for this message.
    
    Specified by:
    
    setUnknownFields in interface Message.Builder
    
    Overrides:
    
    setUnknownFields in class GeneratedMessage.Builder<Field.Builder>
  - mergeUnknownFields
```
public final Field.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Merge some unknown fields into the UnknownFieldSet for this message.
    
    Specified by:
    
    mergeUnknownFields in interface Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class GeneratedMessage.Builder<Field.Builder>

Class Field.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getKindValue

setKindValue

getKind

setKind

clearKind

getCardinalityValue

setCardinalityValue

getCardinality

setCardinality

clearCardinality

getNumber

setNumber

clearNumber

getName

getNameBytes

setName

clearName

setNameBytes

getTypeUrl

getTypeUrlBytes

setTypeUrl

clearTypeUrl

setTypeUrlBytes

getOneofIndex

setOneofIndex

clearOneofIndex

getPacked

setPacked

clearPacked

getOptionsList

getOptionsCount

getOptions

setOptions

setOptions

addOptions

addOptions

addOptions

addOptions

addAllOptions

clearOptions

removeOptions

getOptionsBuilder

getOptionsOrBuilder

getOptionsOrBuilderList

addOptionsBuilder

addOptionsBuilder

getOptionsBuilderList

setUnknownFields

mergeUnknownFields