Class DynamicMessage.Builder
- All Implemented Interfaces:
Message.Builder,MessageLite.Builder,MessageLiteOrBuilder,MessageOrBuilder,Cloneable
- Enclosing class:
- DynamicMessage
DynamicMessages.-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Descriptors.FieldDescriptor[]private final Descriptors.Descriptorprivate UnknownFieldSet -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateConstruct aBuilderfor the given type. -
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(Descriptors.FieldDescriptor field, Object value) LikesetRepeatedField, but appends the value as a new element.build()Constructs the message based on the state of the Builder.private DynamicMessageHelper for DynamicMessage.parseFrom() methods to call.LikeMessageLite.Builder.build(), but does not throw an exception if the message is missing required fields.clear()Resets all fields to their default values.Clears the field.TODO: Clear it when all subclasses have implemented this method.clone()Clones the Builder.Returns a collection of all the fields in this message which are set and their corresponding values.Get an instance of the type with no fields set.Get the message's type's descriptor.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.TODO: Clear it when all subclasses have implemented this method.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.intGets the number of elements of a repeated field.Get theUnknownFieldSetfor this message.booleanReturns true if the given field is set.booleanTODO: Clear it when all subclasses have implemented this method.booleanReturns true if all required fields in the message and all embedded messages are set, false otherwise.Mergeotherinto the message being built.mergeUnknownFields(UnknownFieldSet unknownFields) Merge some unknown fields into theUnknownFieldSetfor this message.Create a builder for messages of the appropriate type for the given field.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.setUnknownFields(UnknownFieldSet unknownFields) Set theUnknownFieldSetfor this message.private static Message.Builderprivate voidVerifies that the field is a field of this message.private voidVerifies that the oneof is an oneof of this message.private voidverifySingularValueType(Descriptors.FieldDescriptor field, Object value) Verifies thatvalueis of the appropriate type, in addition to the checks already performed byFieldSet.Builder.private voidverifyType(Descriptors.FieldDescriptor field, Object value) Verifies thatvalueis of the appropriate type, in addition to the checks already performed byFieldSet.Builder.Methods inherited from class com.google.protobuf.AbstractMessage.Builder
dispose, findInitializationErrors, getInitializationErrorString, getUnknownFieldSetBuilder, internalMergeFrom, markClean, 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.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
-
Field Details
-
type
-
fields
-
oneofCases
-
unknownFields
-
-
Constructor Details
-
Builder
Construct aBuilderfor the given type.
-
-
Method Details
-
clear
Description copied from interface:MessageLite.BuilderResets all fields to their default values.- Specified by:
clearin interfaceMessage.Builder- Specified by:
clearin interfaceMessageLite.Builder- Overrides:
clearin classAbstractMessage.Builder<DynamicMessage.Builder>
-
mergeFrom
Description copied from interface:Message.BuilderMergeotherinto the message being built.othermust have the exact same type asthis(i.e.getDescriptorForType() == other.getDescriptorForType()).Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set inother, thenother's value overwrites the value in this message.
* For singular message fields, if the field is set inother, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements inotherare concatenated with the elements in this message.
* For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.This is equivalent to the
Message::MergeFrommethod in C++.- Specified by:
mergeFromin interfaceMessage.Builder- Overrides:
mergeFromin classAbstractMessage.Builder<DynamicMessage.Builder>
-
build
Description copied from interface:MessageLite.BuilderConstructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message. -
buildParsed
Helper for DynamicMessage.parseFrom() methods to call. ThrowsInvalidProtocolBufferExceptioninstead ofUninitializedMessageException.- Throws:
InvalidProtocolBufferException
-
buildPartial
Description copied from interface:MessageLite.BuilderLikeMessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message. -
clone
Description copied from interface:MessageLite.BuilderClones the Builder.- Specified by:
clonein interfaceMessage.Builder- Specified by:
clonein interfaceMessageLite.Builder- Overrides:
clonein classAbstractMessage.Builder<DynamicMessage.Builder>- See Also:
-
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. -
getDescriptorForType
Description copied from interface:Message.BuilderGet the message's type's descriptor. SeeMessageOrBuilder.getDescriptorForType(). -
getDefaultInstanceForType
Description copied from interface:MessageLiteOrBuilderGet an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from thegetDefaultInstance()method of generated message classes in that this method is an abstract method of theMessageLiteinterface whereasgetDefaultInstance()is a static method of a specific class. They return the same thing. -
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. -
newBuilderForField
Description copied from interface:Message.BuilderCreate 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. -
hasOneof
Description copied from class:AbstractMessage.BuilderTODO: Clear it when all subclasses have implemented this method.- Specified by:
hasOneofin interfaceMessageOrBuilder- Overrides:
hasOneofin classAbstractMessage.Builder<DynamicMessage.Builder>
-
getOneofFieldDescriptor
Description copied from class:AbstractMessage.BuilderTODO: Clear it when all subclasses have implemented this method.- Specified by:
getOneofFieldDescriptorin interfaceMessageOrBuilder- Overrides:
getOneofFieldDescriptorin classAbstractMessage.Builder<DynamicMessage.Builder>
-
clearOneof
Description copied from class:AbstractMessage.BuilderTODO: Clear it when all subclasses have implemented this method.- Specified by:
clearOneofin interfaceMessage.Builder- Overrides:
clearOneofin classAbstractMessage.Builder<DynamicMessage.Builder>
-
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. -
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. -
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. -
clearField
Description copied from interface:Message.BuilderClears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field. -
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. -
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. -
setRepeatedField
public DynamicMessage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value) 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. -
addRepeatedField
Description copied from interface:Message.BuilderLikesetRepeatedField, but appends the value as a new element. -
getUnknownFields
Description copied from interface:MessageOrBuilderGet theUnknownFieldSetfor this message. -
setUnknownFields
Description copied from interface:Message.BuilderSet theUnknownFieldSetfor this message. -
mergeUnknownFields
Description copied from interface:Message.BuilderMerge some unknown fields into theUnknownFieldSetfor this message.- Specified by:
mergeUnknownFieldsin interfaceMessage.Builder- Overrides:
mergeUnknownFieldsin classAbstractMessage.Builder<DynamicMessage.Builder>
-
verifyContainingType
Verifies that the field is a field of this message. -
verifyOneofContainingType
Verifies that the oneof is an oneof of this message. -
verifySingularValueType
Verifies thatvalueis of the appropriate type, in addition to the checks already performed byFieldSet.Builder. -
verifyType
Verifies thatvalueis of the appropriate type, in addition to the checks already performed byFieldSet.Builder. -
getFieldBuilder
Description copied from interface:Message.BuilderGet 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:
getFieldBuilderin interfaceMessage.Builder- Overrides:
getFieldBuilderin classAbstractMessage.Builder<DynamicMessage.Builder>
-
getRepeatedFieldBuilder
Description copied from interface:Message.BuilderGet 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:
getRepeatedFieldBuilderin interfaceMessage.Builder- Overrides:
getRepeatedFieldBuilderin classAbstractMessage.Builder<DynamicMessage.Builder>
-
toMessageBuilder
-