Class GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>
- All Implemented Interfaces:
GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>
,Message.Builder
,MessageLite.Builder
,MessageLiteOrBuilder
,MessageOrBuilder
,Cloneable
- Direct Known Subclasses:
DescriptorProtos.EnumOptions.Builder
,DescriptorProtos.EnumValueOptions.Builder
,DescriptorProtos.ExtensionRangeOptions.Builder
,DescriptorProtos.FieldOptions.Builder
,DescriptorProtos.FileOptions.Builder
,DescriptorProtos.MessageOptions.Builder
,DescriptorProtos.MethodOptions.Builder
,DescriptorProtos.OneofOptions.Builder
,DescriptorProtos.ServiceOptions.Builder
- Enclosing class:
GeneratedMessageV3
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
.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream
-
Field Summary
FieldsModifier and TypeFieldDescription -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
protected
-
Method Summary
Modifier and TypeMethodDescriptionfinal <Type> BuilderType
addExtension
(Extension<MessageType, List<Type>> extension, Type value) Append a value to a repeated extension.final <Type> BuilderType
addExtension
(ExtensionLite<MessageType, List<Type>> extensionLite, Type value) Append a value to a repeated extension.<Type> BuilderType
addExtension
(GeneratedMessage.GeneratedExtension<MessageType, List<Type>> extension, Type value) Append a value to a repeated extension.addRepeatedField
(Descriptors.FieldDescriptor field, Object value) LikesetRepeatedField
, but appends the value as a new element.private FieldSet
<Descriptors.FieldDescriptor> Called by the build code path to create a copy of the extensions for building the message.clear()
Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.final <Type> BuilderType
clearExtension
(Extension<MessageType, ?> extension) Clear an extension.final BuilderType
clearExtension
(ExtensionLite<MessageType, ?> extensionLite) Clear an extension.<Type> BuilderType
clearExtension
(GeneratedMessage.GeneratedExtension<MessageType, ?> extension) Clear an extension.Clears the field.private void
protected boolean
Called by subclasses to check if all extensions are initialized.Returns a collection of all the fields in this message which are set and their corresponding values.final <Type> Type
getExtension
(Extension<MessageType, List<Type>> extension, int index) Get the value of an extension.final <Type> Type
getExtension
(Extension<MessageType, Type> extension) Get the value of an extension.final <Type> Type
getExtension
(ExtensionLite<MessageType, List<Type>> extensionLite, int index) Get one element of a repeated extension.final <Type> Type
getExtension
(ExtensionLite<MessageType, Type> extensionLite) Get the value of an extension.final <Type> Type
getExtension
(GeneratedMessage.GeneratedExtension<MessageType, List<Type>> extension, int index) Get the value of an extension.final <Type> Type
getExtension
(GeneratedMessage.GeneratedExtension<MessageType, Type> extension) Get the value of an extension.final <Type> int
getExtensionCount
(Extension<MessageType, List<Type>> extension) Get the number of elements in a repeated extension.final <Type> int
getExtensionCount
(ExtensionLite<MessageType, List<Type>> extensionLite) Get the number of elements in a repeated extension.final <Type> int
getExtensionCount
(GeneratedMessage.GeneratedExtension<MessageType, List<Type>> extension) Get the number of elements in a repeated extension.Obtains the value of the given field, or the default value if it is not set.Get a nested builder instance for the given field.getRepeatedField
(Descriptors.FieldDescriptor field, int index) Gets an element of a repeated field.getRepeatedFieldBuilder
(Descriptors.FieldDescriptor field, int index) Get a nested builder instance for the given repeated field instance.int
Gets the number of elements of a repeated field.final <Type> boolean
hasExtension
(Extension<MessageType, Type> extension) Check if a singular extension is present.final <Type> boolean
hasExtension
(ExtensionLite<MessageType, Type> extensionLite) Check if a singular extension is present.final <Type> boolean
hasExtension
(GeneratedMessage.GeneratedExtension<MessageType, Type> extension) Check if a singular extension is present.boolean
Returns true if the given field is set.(package private) void
internalSetExtensionSet
(FieldSet<Descriptors.FieldDescriptor> extensions) boolean
Returns true if all required fields in the message and all embedded messages are set, false otherwise.protected final void
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.final <Type> BuilderType
setExtension
(Extension<MessageType, List<Type>> extension, int index, Type value) Set the value of one element of a repeated extension.final <Type> BuilderType
setExtension
(Extension<MessageType, Type> extension, Type value) Set the value of an extension.final <Type> BuilderType
setExtension
(ExtensionLite<MessageType, List<Type>> extensionLite, int index, Type value) Set the value of one element of a repeated extension.final <Type> BuilderType
setExtension
(ExtensionLite<MessageType, Type> extensionLite, Type value) Set the value of an extension.<Type> BuilderType
setExtension
(GeneratedMessage.GeneratedExtension<MessageType, List<Type>> extension, int index, Type value) Set the value of one element of a repeated extension.<Type> BuilderType
setExtension
(GeneratedMessage.GeneratedExtension<MessageType, Type> extension, Type value) Set the value of an extension.setField
(Descriptors.FieldDescriptor field, Object value) Sets a field to the given value.setRepeatedField
(Descriptors.FieldDescriptor field, int index, Object value) Sets an element of a repeated field to the given value.private void
private void
verifyExtensionContainingType
(Extension<MessageType, ?> extension) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
clearOneof, clone, dispose, getDescriptorForType, getOneofFieldDescriptor, getParentForChildren, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetFieldAccessorTable, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, 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.GeneratedMessageV3.ExtendableMessageOrBuilder
getDefaultInstanceForType
Methods inherited from interface com.google.protobuf.Message.Builder
build, buildPartial
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getInitializationErrorString, getOneofFieldDescriptor, getUnknownFields, hasOneof
-
Field Details
-
extensions
-
-
Constructor Details
-
ExtendableBuilder
protected ExtendableBuilder() -
ExtendableBuilder
-
-
Method Details
-
internalSetExtensionSet
-
clear
Description copied from class:GeneratedMessageV3.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 interfaceMessage.Builder
- Specified by:
clear
in interfaceMessageLite.Builder
- Overrides:
clear
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
ensureExtensionsIsMutable
private void ensureExtensionsIsMutable() -
verifyExtensionContainingType
-
hasExtension
Check if a singular extension is present.- Specified by:
hasExtension
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>
-
getExtensionCount
Get the number of elements in a repeated extension.- Specified by:
getExtensionCount
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>
-
getExtension
Get the value of an extension.- Specified by:
getExtension
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>
-
getExtension
public final <Type> Type getExtension(ExtensionLite<MessageType, List<Type>> extensionLite, int index) Get one element of a repeated extension.- Specified by:
getExtension
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>
-
setExtension
public final <Type> BuilderType setExtension(ExtensionLite<MessageType, Type> extensionLite, Type value) Set the value of an extension. -
setExtension
public final <Type> BuilderType setExtension(ExtensionLite<MessageType, List<Type>> extensionLite, int index, Type value) Set the value of one element of a repeated extension. -
addExtension
public final <Type> BuilderType addExtension(ExtensionLite<MessageType, List<Type>> extensionLite, Type value) Append a value to a repeated extension. -
clearExtension
Clear an extension. -
hasExtension
Check if a singular extension is present.- Specified by:
hasExtension
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>
-
hasExtension
public final <Type> boolean hasExtension(GeneratedMessage.GeneratedExtension<MessageType, Type> extension) Check if a singular extension is present.- Specified by:
hasExtension
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>
-
getExtensionCount
Get the number of elements in a repeated extension.- Specified by:
getExtensionCount
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>
-
getExtensionCount
public final <Type> int getExtensionCount(GeneratedMessage.GeneratedExtension<MessageType, List<Type>> extension) Get the number of elements in a repeated extension.- Specified by:
getExtensionCount
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>
-
getExtension
Get the value of an extension.- Specified by:
getExtension
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>
-
getExtension
public final <Type> Type getExtension(GeneratedMessage.GeneratedExtension<MessageType, Type> extension) Get the value of an extension.- Specified by:
getExtension
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>
-
getExtension
Get the value of an extension.- Specified by:
getExtension
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>
-
getExtension
public final <Type> Type getExtension(GeneratedMessage.GeneratedExtension<MessageType, List<Type>> extension, int index) Get the value of an extension.- Specified by:
getExtension
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>
-
setExtension
Set the value of an extension. -
setExtension
public <Type> BuilderType setExtension(GeneratedMessage.GeneratedExtension<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. -
setExtension
public <Type> BuilderType setExtension(GeneratedMessage.GeneratedExtension<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. -
addExtension
public <Type> BuilderType addExtension(GeneratedMessage.GeneratedExtension<MessageType, List<Type>> extension, Type value) Append a value to a repeated extension. -
clearExtension
Clear an extension. -
clearExtension
public <Type> BuilderType clearExtension(GeneratedMessage.GeneratedExtension<MessageType, ?> extension) Clear an extension. -
extensionsAreInitialized
protected boolean extensionsAreInitialized()Called by subclasses to check if all extensions are initialized. -
buildExtensions
Called by the build code path to create a copy of the extensions for building the message. -
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.- Specified by:
isInitialized
in interfaceMessageLiteOrBuilder
- Overrides:
isInitialized
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
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 callingMessageOrBuilder.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 interfaceMessageOrBuilder
- Overrides:
getAllFields
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
getField
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 interfaceMessageOrBuilder
- Overrides:
getField
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
getFieldBuilder
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), however, 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 will be returned. Otherwise, a new field builder will be created and returned. The original message field (if exist) will be merged into the field builder, which will then be nested into its parent builder.
NOTE: implementations that do not support nested builders will throw
UnsupportedOperationException
.- Specified by:
getFieldBuilder
in interfaceMessage.Builder
- Overrides:
getFieldBuilder
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
getRepeatedFieldCount
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 interfaceMessageOrBuilder
- Overrides:
getRepeatedFieldCount
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
getRepeatedField
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 interfaceMessageOrBuilder
- Overrides:
getRepeatedField
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
getRepeatedFieldBuilder
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), however, 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 will be returned. Otherwise, a new field builder will be created and returned. The original message field (if exist) will be merged into the field builder, which will then be nested into its parent builder.
NOTE: implementations that do not support nested builders will throw
UnsupportedOperationException
.- Specified by:
getRepeatedFieldBuilder
in interfaceMessage.Builder
- Overrides:
getRepeatedFieldBuilder
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
hasField
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.- Specified by:
hasField
in interfaceMessageOrBuilder
- Overrides:
hasField
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
setField
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 thatMessageOrBuilder.getField(Descriptors.FieldDescriptor)
would return.- Specified by:
setField
in interfaceMessage.Builder
- Overrides:
setField
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
clearField
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 interfaceMessage.Builder
- Overrides:
clearField
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
setRepeatedField
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 thatMessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int)
would return.- Specified by:
setRepeatedField
in interfaceMessage.Builder
- Overrides:
setRepeatedField
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
addRepeatedField
Description copied from interface:Message.Builder
LikesetRepeatedField
, but appends the value as a new element.- Specified by:
addRepeatedField
in interfaceMessage.Builder
- Overrides:
addRepeatedField
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
newBuilderForField
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 theMessage.Builder.setField(Descriptors.FieldDescriptor, Object)
,Message.Builder.setRepeatedField(Descriptors.FieldDescriptor, int, Object)
, orMessage.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 interfaceMessage.Builder
- Overrides:
newBuilderForField
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>>
-
mergeExtensionFields
-
parseUnknownField
protected boolean parseUnknownField(CodedInputStream input, ExtensionRegistryLite extensionRegistry, int tag) throws IOException Description copied from class:GeneratedMessageV3.Builder
Called by generated subclasses to parse an unknown field.- Overrides:
parseUnknownField
in classGeneratedMessageV3.Builder<BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,
BuilderType>> - Returns:
true
unless the tag is an end-group tag.- Throws:
IOException
-
verifyContainingType
-