GeneratedMessage.ExtendableBuilder

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder<BuilderType>
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessage.Builder<BuilderType>
    - - com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>

All Implemented Interfaces:

GeneratedMessage.ExtendableMessageOrBuilder<MessageType>, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Direct Known Subclasses:

DescriptorProtos.EnumOptions.Builder, DescriptorProtos.EnumValueOptions.Builder, DescriptorProtos.FieldOptions.Builder, DescriptorProtos.FileOptions.Builder, DescriptorProtos.MessageOptions.Builder, DescriptorProtos.MethodOptions.Builder, DescriptorProtos.ServiceOptions.Builder

Enclosing class:

GeneratedMessage
```
public abstract static class GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder>
extends GeneratedMessage.Builder<BuilderType>
implements GeneratedMessage.ExtendableMessageOrBuilder<MessageType>
```
Generated message builders for message types that contain extension ranges subclass this.
This class implements type-safe accessors for extensions. They implement all the same operations that you can do with normal fields -- e.g. "get", "set", and "add" -- but for extensions. The extensions are identified using instances of the class GeneratedMessage.GeneratedExtension; the protocol compiler generates a static instance of this class for every extension in its input. Through the magic of generics, all is made type-safe.

For example, imagine you have the .proto file:
```
 option java_class = "MyProto";

 message Foo {
   extensions 1000 to max;
 }

 extend Foo {
   optional int32 bar;
 }
 
```
Then you might write code like:
```
 MyProto.Foo foo =
   MyProto.Foo.newBuilder()
     .setExtension(MyProto.bar, 123)
     .build();
 
```
See also GeneratedMessage.ExtendableMessage.

Constructor Summary

Constructors

Modifier	Constructor and Description
`protected`	`ExtendableBuilder()`
`protected`	`ExtendableBuilder(GeneratedMessage.BuilderParent parent)`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`<Type> BuilderType`	`addExtension(Extension<MessageType,List<Type>> extension, Type value)` Append a value to a repeated extension.
`BuilderType`	`addRepeatedField(Descriptors.FieldDescriptor field, Object value)` Like `setRepeatedField`, but appends the value as a new element.
`BuilderType`	`clear()` Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
`<Type> BuilderType`	`clearExtension(Extension<MessageType,?> extension)` Clear an extension.
`BuilderType`	`clearField(Descriptors.FieldDescriptor field)` Clears the field.
`BuilderType`	`clone()` Clones the Builder.
`protected boolean`	`extensionsAreInitialized()` Called by subclasses to check if all extensions are initialized.
`Map<Descriptors.FieldDescriptor,Object>`	`getAllFields()` Returns a collection of all the fields in this message which are set and their corresponding values.
`<Type> Type`	`getExtension(Extension<MessageType,List<Type>> extension, int index)` Get one element of a repeated extension.
`<Type> Type`	`getExtension(Extension<MessageType,Type> extension)` Get the value of an extension.
`<Type> int`	`getExtensionCount(Extension<MessageType,List<Type>> extension)` Get the number of elements in a repeated extension.
`Object`	`getField(Descriptors.FieldDescriptor field)` Obtains the value of the given field, or the default value if it is not set.
`Object`	`getRepeatedField(Descriptors.FieldDescriptor field, int index)` Gets an element of a repeated field.
`int`	`getRepeatedFieldCount(Descriptors.FieldDescriptor field)` Gets the number of elements of a repeated field.
`<Type> boolean`	`hasExtension(Extension<MessageType,Type> extension)` Check if a singular extension is present.
`boolean`	`hasField(Descriptors.FieldDescriptor field)` Returns true if the given field is set.
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`protected void`	`mergeExtensionFields(GeneratedMessage.ExtendableMessage other)`
`protected boolean`	`parseUnknownField(CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag)` Called by subclasses to parse an unknown field or an extension.
`<Type> BuilderType`	`setExtension(Extension<MessageType,List<Type>> extension, int index, Type value)` Set the value of one element of a repeated extension.
`<Type> BuilderType`	`setExtension(Extension<MessageType,Type> extension, Type value)` Set the value of an extension.
`BuilderType`	`setField(Descriptors.FieldDescriptor field, Object value)` Sets a field to the given value.
`BuilderType`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)` Sets an element of a repeated field to the given value.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
clearOneof, getDescriptorForType, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getUnknownFields, hasOneof, internalGetFieldAccessorTable, isClean, markClean, mergeUnknownFields, newBuilderForField, onBuilt, onChanged, setUnknownFields

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, 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.GeneratedMessage.ExtendableMessageOrBuilder
getDefaultInstanceForType

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getDescriptorForType, getInitializationErrorString, getOneofFieldDescriptor, getUnknownFields, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
build, buildPartial

- Constructor Detail
  - ExtendableBuilder
```
protected ExtendableBuilder()
```
  - ExtendableBuilder
```
protected ExtendableBuilder(GeneratedMessage.BuilderParent parent)
```
- Method Detail
  - clear
```
public BuilderType 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.
  - clone
```
public BuilderType clone()
```
    Description copied from interface: MessageLite.Builder
    
    Clones the Builder.
    
    Specified by:
    
    clone in interface Message.Builder
    
    Specified by:
    
    clone in interface MessageLite.Builder
    
    Overrides:
    
    clone in class GeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder>
    
    See Also:
    
    Object.clone()
  - hasExtension
```
public final <Type> boolean hasExtension(Extension<MessageType,Type> extension)
```
    Check if a singular extension is present.
  - getExtensionCount
```
public final <Type> int getExtensionCount(Extension<MessageType,List<Type>> extension)
```
    Get the number of elements in a repeated extension.
  - getExtension
```
public final <Type> Type getExtension(Extension<MessageType,Type> extension)
```
    Get the value of an extension.
  - getExtension
```
public final <Type> Type getExtension(Extension<MessageType,List<Type>> extension,
                                      int index)
```
    Get one element of a repeated extension.
  - setExtension
```
public final <Type> BuilderType setExtension(Extension<MessageType,Type> extension,
                                             Type value)
```
    Set the value of an extension.
  - setExtension
```
public final <Type> BuilderType setExtension(Extension<MessageType,List<Type>> extension,
                                             int index,
                                             Type value)
```
    Set the value of one element of a repeated extension.
  - addExtension
```
public final <Type> BuilderType addExtension(Extension<MessageType,List<Type>> extension,
                                             Type value)
```
    Append a value to a repeated extension.
  - clearExtension
```
public final <Type> BuilderType clearExtension(Extension<MessageType,?> extension)
```
    Clear an extension.
  - extensionsAreInitialized
```
protected boolean extensionsAreInitialized()
```
    Called by subclasses to check if all extensions are initialized.
  - isInitialized
```
public 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()
  - parseUnknownField
```
protected boolean parseUnknownField(CodedInputStream input,
                                    UnknownFieldSet.Builder unknownFields,
                                    ExtensionRegistryLite extensionRegistry,
                                    int tag)
                             throws IOException
```
    Called by subclasses to parse an unknown field or an extension.
    
    Overrides:
    
    parseUnknownField in class GeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder>
    
    Returns:
    
    true unless the tag is an end-group tag.
    
    Throws:
    
    IOException
  - getAllFields
```
public Map<Descriptors.FieldDescriptor,Object> getAllFields()
```
    Description copied from interface: MessageOrBuilder
    
    Returns a collection of all the fields in this message which are set and their corresponding values. A singular ("required" or "optional") field is set iff hasField() returns true for that field. A "repeated" field is set iff getRepeatedFieldCount() is greater than zero. The values are exactly what would be returned by calling MessageOrBuilder.getField(Descriptors.FieldDescriptor) for each field. The map is guaranteed to be a sorted map, so iterating over it will return fields in order by field number.
    If this is for a builder, the returned map may or may not reflect future changes to the builder. Either way, the returned map is itself unmodifiable.
  - getField
```
public Object getField(Descriptors.FieldDescriptor field)
```
    Description copied from interface: MessageOrBuilder
    
    Obtains the value of the given field, or the default value if it is not set. For primitive fields, the boxed primitive value is returned. For enum fields, the EnumValueDescriptor for the value is returned. For embedded message fields, the sub-message is returned. For repeated fields, a java.util.List is returned.
  - getRepeatedFieldCount
```
public int getRepeatedFieldCount(Descriptors.FieldDescriptor field)
```
    Description copied from interface: MessageOrBuilder
    
    Gets the number of elements of a repeated field. This is exactly equivalent to calling the generated "Count" accessor method corresponding to the field.
  - getRepeatedField
```
public Object getRepeatedField(Descriptors.FieldDescriptor field,
                               int index)
```
    Description copied from interface: MessageOrBuilder
    
    Gets an element of a repeated field. For primitive fields, the boxed primitive value is returned. For enum fields, the EnumValueDescriptor for the value is returned. For embedded message fields, the sub-message is returned.
  - hasField
```
public boolean hasField(Descriptors.FieldDescriptor field)
```
    Description copied from interface: MessageOrBuilder
    
    Returns true if the given field is set. This is exactly equivalent to calling the generated "has" accessor method corresponding to the field.
  - setField
```
public BuilderType setField(Descriptors.FieldDescriptor field,
                            Object value)
```
    Description copied from interface: Message.Builder
    
    Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getField(Descriptors.FieldDescriptor) would return.
  - clearField
```
public BuilderType clearField(Descriptors.FieldDescriptor field)
```
    Description copied from interface: Message.Builder
    
    Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.
  - setRepeatedField
```
public BuilderType setRepeatedField(Descriptors.FieldDescriptor field,
                                    int index,
                                    Object value)
```
    Description copied from interface: Message.Builder
    
    Sets an element of a repeated field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int) would return.
  - addRepeatedField
```
public BuilderType addRepeatedField(Descriptors.FieldDescriptor field,
                                    Object value)
```
    Description copied from interface: Message.Builder
    
    Like setRepeatedField, but appends the value as a new element.
  - mergeExtensionFields
```
protected final void mergeExtensionFields(GeneratedMessage.ExtendableMessage other)
```

Class GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder>

Constructor Summary

Constructors

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.GeneratedMessage.ExtendableMessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Constructor Detail

ExtendableBuilder

ExtendableBuilder

Method Detail

clear

clone

hasExtension

getExtensionCount

getExtension

getExtension

setExtension

setExtension

addExtension

clearExtension

extensionsAreInitialized

isInitialized

parseUnknownField

getAllFields

getField

getRepeatedFieldCount

getRepeatedField

hasField

setField

clearField

setRepeatedField

addRepeatedField

mergeExtensionFields