Package com.google.protobuf

Class GeneratedMessage.ExtendableBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>

All Implemented Interfaces:

GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Direct Known Subclasses:

DescriptorProtos.EnumOptions.Builder, DescriptorProtos.EnumValueOptions.Builder, DescriptorProtos.ExtensionRangeOptions.Builder, DescriptorProtos.FeatureSet.Builder, DescriptorProtos.FieldOptions.Builder, DescriptorProtos.FileOptions.Builder, DescriptorProtos.MessageOptions.Builder, DescriptorProtos.MethodOptions.Builder, DescriptorProtos.OneofOptions.Builder, DescriptorProtos.ServiceOptions.Builder, GeneratedMessageV3.ExtendableBuilder

Enclosing class:

GeneratedMessage

public abstract static class GeneratedMessage.ExtendableBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>
extends GeneratedMessage.Builder<BuilderT>
implements GeneratedMessage.ExtendableMessageOrBuilder<MessageT>

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	Description
protected	ExtendableBuilder()
protected	ExtendableBuilder(AbstractMessage.BuilderParent parent)

Method Summary

Modifier and Type	Method	Description
<T> BuilderT	addExtension(ExtensionLite<MessageT,java.util.List<T>> extensionLite, T value)	Append a value to a repeated extension.
BuilderT	addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)	Like setRepeatedField, but appends the value as a new element.
BuilderT	clear()	Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
<T> BuilderT	clearExtension(ExtensionLite<MessageT,T> extensionLite)	Clear an extension.
BuilderT	clearField(Descriptors.FieldDescriptor field)	Clears the field.
protected boolean	extensionsAreInitialized()	Called by subclasses to check if all extensions are initialized.
java.util.Map<Descriptors.FieldDescriptor,java.lang.Object>	getAllFields()	Returns a collection of all the fields in this message which are set and their corresponding values.
<T> T	getExtension(ExtensionLite<MessageT,java.util.List<T>> extensionLite, int index)	Get one element of a repeated extension.
<T> T	getExtension(ExtensionLite<MessageT,T> extensionLite)	Get the value of an extension.
<T> int	getExtensionCount(ExtensionLite<MessageT,java.util.List<T>> extensionLite)	Get the number of elements in a repeated extension.
java.lang.Object	getField(Descriptors.FieldDescriptor field)	Obtains the value of the given field, or the default value if it is not set.
Message.Builder	getFieldBuilder(Descriptors.FieldDescriptor field)	Get a nested builder instance for the given field.
java.lang.Object	getRepeatedField(Descriptors.FieldDescriptor field, int index)	Gets an element of a repeated field.
Message.Builder	getRepeatedFieldBuilder(Descriptors.FieldDescriptor field, int index)	Get a nested builder instance for the given repeated field instance.
int	getRepeatedFieldCount(Descriptors.FieldDescriptor field)	Gets the number of elements of a repeated field.
<T> boolean	hasExtension(ExtensionLite<MessageT,T> extensionLite)	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)
Message.Builder	newBuilderForField(Descriptors.FieldDescriptor field)	Create a builder for messages of the appropriate type for the given field.
protected boolean	parseUnknownField(CodedInputStream input, ExtensionRegistryLite extensionRegistry, int tag)	Called by generated subclasses to parse an unknown field.
<T> BuilderT	setExtension(ExtensionLite<MessageT,java.util.List<T>> extensionLite, int index, T value)	Set the value of one element of a repeated extension.
<T> BuilderT	setExtension(ExtensionLite<MessageT,T> extensionLite, T value)	Set the value of an extension.
BuilderT	setField(Descriptors.FieldDescriptor field, java.lang.Object value)	Sets a field to the given value.
BuilderT	setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)	Sets an element of a repeated field to the given value.

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

clearOneof, clone, getDescriptorForType, getOneofFieldDescriptor, getParentForChildren, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetFieldAccessorTable, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

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

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.GeneratedMessage.ExtendableMessageOrBuilder

getDefaultInstanceForType

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

build, buildPartial, mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getInitializationErrorString, getOneofFieldDescriptor, getUnknownFields, hasOneof

Constructor Detail

ExtendableBuilder

protected ExtendableBuilder()

ExtendableBuilder

protected ExtendableBuilder(AbstractMessage.BuilderParent parent)

Method Detail

clear

public BuilderT 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<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

hasExtension

public final <T> boolean hasExtension(ExtensionLite<MessageT,T> extensionLite)

Check if a singular extension is present.

Specified by:

hasExtension in interface GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>>

getExtensionCount

public final <T> int getExtensionCount(ExtensionLite<MessageT,java.util.List<T>> extensionLite)

Get the number of elements in a repeated extension.

Specified by:

getExtensionCount in interface GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>>

getExtension

public final <T> T getExtension(ExtensionLite<MessageT,T> extensionLite)

Get the value of an extension.

Specified by:

getExtension in interface GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>>

getExtension

public final <T> T getExtension(ExtensionLite<MessageT,java.util.List<T>> extensionLite,
                                int index)

Get one element of a repeated extension.

Specified by:

getExtension in interface GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>>

setExtension

public final <T> BuilderT setExtension(ExtensionLite<MessageT,T> extensionLite,
                                       T value)

Set the value of an extension.

setExtension

public final <T> BuilderT setExtension(ExtensionLite<MessageT,java.util.List<T>> extensionLite,
                                       int index,
                                       T value)

Set the value of one element of a repeated extension.

addExtension

public final <T> BuilderT addExtension(ExtensionLite<MessageT,java.util.List<T>> extensionLite,
                                       T value)

Append a value to a repeated extension.

clearExtension

public final <T> BuilderT clearExtension(ExtensionLite<MessageT,T> extensionLite)

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()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

getAllFields

public java.util.Map<Descriptors.FieldDescriptor,java.lang.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.

Specified by:

getAllFields in interface MessageOrBuilder

Overrides:

getAllFields in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

getField

public java.lang.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.

Specified by:

getField in interface MessageOrBuilder

Overrides:

getField in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

getFieldBuilder

public Message.Builder getFieldBuilder(Descriptors.FieldDescriptor field)

Description copied from interface: Message.Builder

Get a nested builder instance for the given field.

Normally, we hold a reference to the immutable message object for the message type field. Some implementations (the generated message builders) can also hold a reference to the builder object (a nested builder) for the field.

If the field is already backed up by a nested builder, the nested builder is returned. Otherwise, a new field builder is created and returned. The original message field (if one exists) is merged into the field builder, which is then nested into its parent builder.

Specified by:

getFieldBuilder in interface Message.Builder

Overrides:

getFieldBuilder in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

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.

Specified by:

getRepeatedFieldCount in interface MessageOrBuilder

Overrides:

getRepeatedFieldCount in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

getRepeatedField

public java.lang.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.

Specified by:

getRepeatedField in interface MessageOrBuilder

Overrides:

getRepeatedField in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

getRepeatedFieldBuilder

public Message.Builder getRepeatedFieldBuilder(Descriptors.FieldDescriptor field,
                                               int index)

Description copied from interface: Message.Builder

Get a nested builder instance for the given repeated field instance.

Normally, we hold a reference to the immutable message object for the message type field. Some implementations (the generated message builders) can also hold a reference to the builder object (a nested builder) for the field.

If the field is already backed up by a nested builder, the nested builder is returned. Otherwise, a new field builder is created and returned. The original message field (if one exists) is merged into the field builder, which is then nested into its parent builder.

Specified by:

getRepeatedFieldBuilder in interface Message.Builder

Overrides:

getRepeatedFieldBuilder in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

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. The return value of hasField() is semantically meaningful only for fields where field.hasPresence() == true.

Specified by:

hasField in interface MessageOrBuilder

Overrides:

hasField in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

setField

public BuilderT setField(Descriptors.FieldDescriptor field,
                         java.lang.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, that is, the same type that MessageOrBuilder.getField(Descriptors.FieldDescriptor) returns.

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

clearField

public BuilderT 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.

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

setRepeatedField

public BuilderT setRepeatedField(Descriptors.FieldDescriptor field,
                                 int index,
                                 java.lang.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; that is, the same type that MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int) returns.

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

addRepeatedField

public BuilderT addRepeatedField(Descriptors.FieldDescriptor field,
                                 java.lang.Object value)

Description copied from interface: Message.Builder

Like setRepeatedField, but appends the value as a new element.

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

newBuilderForField

public Message.Builder newBuilderForField(Descriptors.FieldDescriptor field)

Description copied from interface: Message.Builder

Create a builder for messages of the appropriate type for the given field. The builder is NOT nested in the current builder. However, messages built with the builder can then be passed to the Message.Builder.setField(Descriptors.FieldDescriptor, Object), Message.Builder.setRepeatedField(Descriptors.FieldDescriptor, int, Object), or Message.Builder.addRepeatedField(Descriptors.FieldDescriptor, Object) method of the current builder.

To obtain a builder nested in the current builder, use Message.Builder.getFieldBuilder(Descriptors.FieldDescriptor) instead.

Specified by:

newBuilderForField in interface Message.Builder

Overrides:

newBuilderForField in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

mergeExtensionFields

protected final void mergeExtensionFields(GeneratedMessage.ExtendableMessage<?> other)

parseUnknownField

protected boolean parseUnknownField(CodedInputStream input,
                                    ExtensionRegistryLite extensionRegistry,
                                    int tag)
                             throws java.io.IOException

Description copied from class: GeneratedMessage.Builder

Called by generated subclasses to parse an unknown field.

Overrides:

parseUnknownField in class GeneratedMessage.Builder<BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>

Returns:

true unless the tag is an end-group tag.

Throws:

java.io.IOException