Package com.google.protobuf
Class GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
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
- Enclosing class:
- GeneratedMessage
public abstract static class GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedprotected -
Method Summary
Modifier and TypeMethodDescriptionfinal <Type> BuilderTypeaddExtension(Extension<MessageType, List<Type>> extension, Type value) Append a value to a repeated extension.final <Type> BuilderTypeaddExtension(ExtensionLite<MessageType, List<Type>> extensionLite, Type value) Append a value to a repeated extension.<Type> BuilderTypeaddExtension(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> BuilderTypeclearExtension(Extension<MessageType, ?> extension) Clear an extension.final <Type> BuilderTypeclearExtension(ExtensionLite<MessageType, ?> extensionLite) Clear an extension.<Type> BuilderTypeclearExtension(GeneratedMessage.GeneratedExtension<MessageType, ?> extension) Clear an extension.Clears the field.clone()Clones the Builder.private voidprotected booleanCalled 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> TypegetExtension(Extension<MessageType, List<Type>> extension, int index) Get the value of an extension.final <Type> TypegetExtension(Extension<MessageType, Type> extension) Get the value of an extension.final <Type> TypegetExtension(ExtensionLite<MessageType, List<Type>> extensionLite, int index) Get one element of a repeated extension.final <Type> TypegetExtension(ExtensionLite<MessageType, Type> extensionLite) Get the value of an extension.final <Type> TypegetExtension(GeneratedMessage.GeneratedExtension<MessageType, List<Type>> extension, int index) Get the value of an extension.final <Type> TypegetExtension(GeneratedMessage.GeneratedExtension<MessageType, Type> extension) Get the value of an extension.final <Type> intgetExtensionCount(Extension<MessageType, List<Type>> extension) Get the number of elements in a repeated extension.final <Type> intgetExtensionCount(ExtensionLite<MessageType, List<Type>> extensionLite) Get the number of elements in a repeated extension.final <Type> intgetExtensionCount(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.getRepeatedField(Descriptors.FieldDescriptor field, int index) Gets an element of a repeated field.intGets the number of elements of a repeated field.final <Type> booleanhasExtension(Extension<MessageType, Type> extension) Check if a singular extension is present.final <Type> booleanhasExtension(ExtensionLite<MessageType, Type> extensionLite) Check if a singular extension is present.final <Type> booleanhasExtension(GeneratedMessage.GeneratedExtension<MessageType, Type> extension) Check if a singular extension is present.booleanReturns true if the given field is set.(package private) voidinternalSetExtensionSet(FieldSet<Descriptors.FieldDescriptor> extensions) booleanReturns true if all required fields in the message and all embedded messages are set, false otherwise.protected final voidprotected booleanparseUnknownField(CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag) Called by subclasses to parse an unknown field or an extension.final <Type> BuilderTypesetExtension(Extension<MessageType, List<Type>> extension, int index, Type value) Set the value of one element of a repeated extension.final <Type> BuilderTypesetExtension(Extension<MessageType, Type> extension, Type value) Set the value of an extension.final <Type> BuilderTypesetExtension(ExtensionLite<MessageType, List<Type>> extensionLite, int index, Type value) Set the value of one element of a repeated extension.final <Type> BuilderTypesetExtension(ExtensionLite<MessageType, Type> extensionLite, Type value) Set the value of an extension.<Type> BuilderTypesetExtension(GeneratedMessage.GeneratedExtension<MessageType, List<Type>> extension, int index, Type value) Set the value of one element of a repeated extension.<Type> BuilderTypesetExtension(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 voidprivate voidverifyExtensionContainingType(Extension<MessageType, ?> extension) Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
clearOneof, dispose, getDescriptorForType, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedFieldBuilder, getUnknownFields, hasOneof, internalGetFieldAccessorTable, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, newBuilderForField, onBuilt, onChanged, setUnknownFieldsMethods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, getUnknownFieldSetBuilder, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, setUnknownFieldSetBuilder, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder
getDefaultInstanceForTypeMethods inherited from interface com.google.protobuf.Message.Builder
build, buildPartial, mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods 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:GeneratedMessage.BuilderCalled by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.- Specified by:
clearin interfaceMessage.Builder- Specified by:
clearin interfaceMessageLite.Builder- Overrides:
clearin classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
-
clone
Description copied from interface:MessageLite.BuilderClones the Builder.- Specified by:
clonein interfaceMessage.Builder- Specified by:
clonein interfaceMessageLite.Builder- Overrides:
clonein classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>> - See Also:
-
ensureExtensionsIsMutable
private void ensureExtensionsIsMutable() -
verifyExtensionContainingType
-
hasExtension
Check if a singular extension is present.- Specified by:
hasExtensionin interfaceGeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>
-
getExtensionCount
Get the number of elements in a repeated extension.- Specified by:
getExtensionCountin interfaceGeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>
-
getExtension
Get the value of an extension.- Specified by:
getExtensionin interfaceGeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>
-
getExtension
public final <Type> Type getExtension(ExtensionLite<MessageType, List<Type>> extensionLite, int index) Get one element of a repeated extension.- Specified by:
getExtensionin interfaceGeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.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:
hasExtensionin interfaceGeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>
-
hasExtension
public final <Type> boolean hasExtension(GeneratedMessage.GeneratedExtension<MessageType, Type> extension) Check if a singular extension is present.- Specified by:
hasExtensionin interfaceGeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>
-
getExtensionCount
Get the number of elements in a repeated extension.- Specified by:
getExtensionCountin interfaceGeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>
-
getExtensionCount
public final <Type> int getExtensionCount(GeneratedMessage.GeneratedExtension<MessageType, List<Type>> extension) Get the number of elements in a repeated extension.- Specified by:
getExtensionCountin interfaceGeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>
-
getExtension
Get the value of an extension.- Specified by:
getExtensionin interfaceGeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>
-
getExtension
public final <Type> Type getExtension(GeneratedMessage.GeneratedExtension<MessageType, Type> extension) Get the value of an extension.- Specified by:
getExtensionin interfaceGeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>
-
getExtension
Get the value of an extension.- Specified by:
getExtensionin interfaceGeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>
-
getExtension
public final <Type> Type getExtension(GeneratedMessage.GeneratedExtension<MessageType, List<Type>> extension, int index) Get the value of an extension.- Specified by:
getExtensionin interfaceGeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.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:MessageLiteOrBuilderReturns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitializedin interfaceMessageLiteOrBuilder- Overrides:
isInitializedin classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
-
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:
parseUnknownFieldin classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>> - Returns:
trueunless the tag is an end-group tag.- Throws:
IOException
-
getAllFields
Description copied from interface:MessageOrBuilderReturns 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:
getAllFieldsin interfaceMessageOrBuilder- Overrides:
getAllFieldsin classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
-
getField
Description copied from interface:MessageOrBuilderObtains 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:
getFieldin interfaceMessageOrBuilder- Overrides:
getFieldin classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
-
getRepeatedFieldCount
Description copied from interface:MessageOrBuilderGets 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:
getRepeatedFieldCountin interfaceMessageOrBuilder- Overrides:
getRepeatedFieldCountin classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
-
getRepeatedField
Description copied from interface:MessageOrBuilderGets 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:
getRepeatedFieldin interfaceMessageOrBuilder- Overrides:
getRepeatedFieldin classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
-
hasField
Description copied from interface:MessageOrBuilderReturns 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:
hasFieldin interfaceMessageOrBuilder- Overrides:
hasFieldin classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
-
setField
Description copied from interface:Message.BuilderSets a field to the given value. The value must be of the correct type for this field, that is, the same type thatMessageOrBuilder.getField(Descriptors.FieldDescriptor)returns.- Specified by:
setFieldin interfaceMessage.Builder- Overrides:
setFieldin classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
-
clearField
Description copied from interface:Message.BuilderClears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.- Specified by:
clearFieldin interfaceMessage.Builder- Overrides:
clearFieldin classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
-
setRepeatedField
Description copied from interface:Message.BuilderSets 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 thatMessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int)returns.- Specified by:
setRepeatedFieldin interfaceMessage.Builder- Overrides:
setRepeatedFieldin classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
-
addRepeatedField
Description copied from interface:Message.BuilderLikesetRepeatedField, but appends the value as a new element.- Specified by:
addRepeatedFieldin interfaceMessage.Builder- Overrides:
addRepeatedFieldin classGeneratedMessage.Builder<BuilderType extends GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>
-
mergeExtensionFields
-
verifyContainingType
-