public abstract static class GeneratedMessageV3.ExtendableBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>> extends GeneratedMessageV3.Builder<BuilderT> implements GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT>
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 GeneratedMessageV3.ExtendableMessage.
| Modifier | Constructor and Description |
|---|---|
protected |
ExtendableBuilder() |
protected |
ExtendableBuilder(GeneratedMessageV3.BuilderParent parent) |
| Modifier and Type | Method and Description |
|---|---|
<T> BuilderT |
addExtension(Extension<MessageT,List<T>> extension,
T value)
Append a value to a repeated extension.
|
<T> BuilderT |
addExtension(ExtensionLite<MessageT,List<T>> extensionLite,
T value)
Append a value to a repeated extension.
|
<T> BuilderT |
addExtension(GeneratedMessage.GeneratedExtension<MessageT,List<T>> extension,
T value)
Append a value to a repeated extension.
|
BuilderT |
addRepeatedField(Descriptors.FieldDescriptor field,
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(Extension<MessageT,T> extension)
Clear an extension.
|
<T> BuilderT |
clearExtension(ExtensionLite<MessageT,T> extensionLite)
Clear an extension.
|
<T> BuilderT |
clearExtension(GeneratedMessage.GeneratedExtension<MessageT,T> extension)
Clears an extension.
|
BuilderT |
clearField(Descriptors.FieldDescriptor field)
Clears the field.
|
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.
|
<T> T |
getExtension(Extension<MessageT,List<T>> extension,
int index)
Get the value of an extension.
|
<T> T |
getExtension(Extension<MessageT,T> extension)
Get the value of an extension.
|
<T> T |
getExtension(ExtensionLite<MessageT,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> T |
getExtension(GeneratedMessage.GeneratedExtension<MessageT,List<T>> extension,
int index)
Get the value of an extension.
|
<T> T |
getExtension(GeneratedMessage.GeneratedExtension<MessageT,T> extension)
Get the value of an extension.
|
<T> int |
getExtensionCount(Extension<MessageT,List<T>> extension)
Get the number of elements in a repeated extension.
|
<T> int |
getExtensionCount(ExtensionLite<MessageT,List<T>> extensionLite)
Get the number of elements in a repeated extension.
|
<T> int |
getExtensionCount(GeneratedMessage.GeneratedExtension<MessageT,List<T>> 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.
|
Message.Builder |
getFieldBuilder(Descriptors.FieldDescriptor field)
Get a nested builder instance for the given field.
|
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(Extension<MessageT,T> extension)
Check if a singular extension is present.
|
<T> boolean |
hasExtension(ExtensionLite<MessageT,T> extensionLite)
Check if a singular extension is present.
|
<T> boolean |
hasExtension(GeneratedMessage.GeneratedExtension<MessageT,T> 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(GeneratedMessageV3.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(Extension<MessageT,List<T>> extension,
int index,
T value)
Set the value of one element of a repeated extension.
|
<T> BuilderT |
setExtension(Extension<MessageT,T> extension,
T value)
Set the value of an extension.
|
<T> BuilderT |
setExtension(ExtensionLite<MessageT,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.
|
<T> BuilderT |
setExtension(GeneratedMessage.GeneratedExtension<MessageT,List<T>> extension,
int index,
T value)
Set the value of one element of a repeated extension.
|
<T> BuilderT |
setExtension(GeneratedMessage.GeneratedExtension<MessageT,T> extension,
T value)
Set the value of an extension.
|
BuilderT |
setField(Descriptors.FieldDescriptor field,
Object value)
Sets a field to the given value.
|
BuilderT |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
Object value)
Sets an element of a repeated field to the given value.
|
clearOneof, clone, getDescriptorForType, getOneofFieldDescriptor, getParentForChildren, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetFieldAccessorTable, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetDefaultInstanceForTypefindInitializationErrors, getDescriptorForType, getInitializationErrorString, getOneofFieldDescriptor, getUnknownFields, hasOneofbuild, buildPartial, mergeDelimitedFrom, mergeDelimitedFrommergeFromprotected ExtendableBuilder()
protected ExtendableBuilder(GeneratedMessageV3.BuilderParent parent)
public BuilderT clear()
GeneratedMessageV3.Builderclear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public final <T> boolean hasExtension(ExtensionLite<MessageT,T> extensionLite)
hasExtension in interface GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>public final <T> int getExtensionCount(ExtensionLite<MessageT,List<T>> extensionLite)
getExtensionCount in interface GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>public final <T> T getExtension(ExtensionLite<MessageT,T> extensionLite)
getExtension in interface GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>public final <T> T getExtension(ExtensionLite<MessageT,List<T>> extensionLite, int index)
getExtension in interface GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>public final <T> BuilderT setExtension(ExtensionLite<MessageT,T> extensionLite, T value)
public final <T> BuilderT setExtension(ExtensionLite<MessageT,List<T>> extensionLite, int index, T value)
public final <T> BuilderT addExtension(ExtensionLite<MessageT,List<T>> extensionLite, T value)
public final <T> BuilderT clearExtension(ExtensionLite<MessageT,T> extensionLite)
public final <T> boolean hasExtension(Extension<MessageT,T> extension)
TODO(b/258340024): handled by ExtensionLite version
hasExtension in interface GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>public final <T> boolean hasExtension(GeneratedMessage.GeneratedExtension<MessageT,T> extension)
TODO(b/258340024): handled by ExtensionLite version
hasExtension in interface GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>public final <T> int getExtensionCount(Extension<MessageT,List<T>> extension)
TODO(b/258340024): handled by ExtensionLite version
getExtensionCount in interface GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>public final <T> int getExtensionCount(GeneratedMessage.GeneratedExtension<MessageT,List<T>> extension)
TODO(b/258340024): handled by ExtensionLite version
getExtensionCount in interface GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>public final <T> T getExtension(Extension<MessageT,T> extension)
TODO(b/258340024): handled by ExtensionLite version
getExtension in interface GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>public final <T> T getExtension(GeneratedMessage.GeneratedExtension<MessageT,T> extension)
TODO(b/258340024): handled by ExtensionLite version
getExtension in interface GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>public final <T> T getExtension(Extension<MessageT,List<T>> extension, int index)
TODO(b/258340024): handled by ExtensionLite version
getExtension in interface GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>public final <T> T getExtension(GeneratedMessage.GeneratedExtension<MessageT,List<T>> extension, int index)
TODO(b/258340024): handled by ExtensionLite version
getExtension in interface GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>public final <T> BuilderT setExtension(Extension<MessageT,T> extension, T value)
TODO(b/258340024): handled by ExtensionLite version
public <T> BuilderT setExtension(GeneratedMessage.GeneratedExtension<MessageT,T> extension, T value)
TODO(b/258340024): handled by ExtensionLite version
public final <T> BuilderT setExtension(Extension<MessageT,List<T>> extension, int index, T value)
TODO(b/258340024): handled by ExtensionLite version
public <T> BuilderT setExtension(GeneratedMessage.GeneratedExtension<MessageT,List<T>> extension, int index, T value)
TODO(b/258340024): handled by ExtensionLite version
public final <T> BuilderT addExtension(Extension<MessageT,List<T>> extension, T value)
TODO(b/258340024): handled by ExtensionLite version
public <T> BuilderT addExtension(GeneratedMessage.GeneratedExtension<MessageT,List<T>> extension, T value)
TODO(b/258340024): handled by ExtensionLite version
public final <T> BuilderT clearExtension(Extension<MessageT,T> extension)
TODO(b/258340024): handled by ExtensionLite version
public <T> BuilderT clearExtension(GeneratedMessage.GeneratedExtension<MessageT,T> extension)
TODO(b/258340024): handled by ExtensionLite version
protected boolean extensionsAreInitialized()
public boolean isInitialized()
MessageLiteOrBuilderisInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public Map<Descriptors.FieldDescriptor,Object> getAllFields()
MessageOrBuilderMessageOrBuilder.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. getAllFields in interface MessageOrBuildergetAllFields in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public Object getField(Descriptors.FieldDescriptor field)
MessageOrBuildergetField in interface MessageOrBuildergetField in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public Message.Builder getFieldBuilder(Descriptors.FieldDescriptor field)
Message.BuilderNormally, 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.
getFieldBuilder in interface Message.BuildergetFieldBuilder in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public int getRepeatedFieldCount(Descriptors.FieldDescriptor field)
MessageOrBuildergetRepeatedFieldCount in interface MessageOrBuildergetRepeatedFieldCount in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public Object getRepeatedField(Descriptors.FieldDescriptor field, int index)
MessageOrBuildergetRepeatedField in interface MessageOrBuildergetRepeatedField in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public Message.Builder getRepeatedFieldBuilder(Descriptors.FieldDescriptor field, int index)
Message.BuilderNormally, 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.
getRepeatedFieldBuilder in interface Message.BuildergetRepeatedFieldBuilder in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public boolean hasField(Descriptors.FieldDescriptor field)
MessageOrBuilderhasField in interface MessageOrBuilderhasField in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public BuilderT setField(Descriptors.FieldDescriptor field, Object value)
Message.BuilderMessageOrBuilder.getField(Descriptors.FieldDescriptor) returns.setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public BuilderT clearField(Descriptors.FieldDescriptor field)
Message.BuilderclearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public BuilderT setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Message.BuilderMessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int) returns.setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public BuilderT addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Message.BuildersetRepeatedField, but appends the value as a new element.addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>public Message.Builder newBuilderForField(Descriptors.FieldDescriptor field)
Message.BuilderMessage.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.
newBuilderForField in interface Message.BuildernewBuilderForField in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>protected final void mergeExtensionFields(GeneratedMessageV3.ExtendableMessage<?> other)
protected boolean parseUnknownField(CodedInputStream input, ExtensionRegistryLite extensionRegistry, int tag) throws IOException
GeneratedMessageV3.BuilderparseUnknownField in class GeneratedMessageV3.Builder<BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>true unless the tag is an end-group tag.IOExceptionCopyright © 2008–2023. All rights reserved.