Class AbstractMessage.Builder<BuilderType extends AbstractMessage.Builder<BuilderType>>
- All Implemented Interfaces:
Message.Builder,MessageLite.Builder,MessageLiteOrBuilder,MessageOrBuilder,Cloneable
- Direct Known Subclasses:
DynamicMessage.Builder,GeneratedMessage.Builder,GeneratedMessageV3.Builder,MapEntry.Builder
- Enclosing class:
- AbstractMessage
Message.Builder interface which implements as many
methods of that interface as possible in terms of other methods.-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclear()Resets all fields to their default values.TODO: Clear it when all subclasses have implemented this method.clone()Clones the Builder.(package private) voiddispose()Used to support nested builders and called when this nested builder is no longer used by its parent builder and should release the reference to its parent builder.Returns a list of field paths (e.g.Get a nested builder instance for the given field.Returns a comma-delimited list of required fields which are not set in this message object.TODO: Clear it when all subclasses have implemented this method.getRepeatedFieldBuilder(Descriptors.FieldDescriptor field, int index) Get a nested builder instance for the given repeated field instance.protected UnknownFieldSet.BuilderbooleanTODO: Clear it when all subclasses have implemented this method.protected BuilderType(package private) voidUsed to support nested builders and called to mark this builder as clean.mergeFrom(byte[] data) Parsedataas a message of this type and merge it with the message being built.mergeFrom(byte[] data, int off, int len) Parsedataas a message of this type and merge it with the message being built.mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) Parsedataas a message of this type and merge it with the message being built.mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry) Parsedataas a message of this type and merge it with the message being built.mergeFrom(ByteString data) Parsedataas a message of this type and merge it with the message being built.mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry) Parsedataas a message of this type and merge it with the message being built.mergeFrom(CodedInputStream input) Parses a message of this type from the input and merges it with this message.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) LikeMessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.Mergeotherinto the message being built.(package private) BuilderTypemergeFrom(Message other, Map<Descriptors.FieldDescriptor, Object> allFields) mergeFrom(InputStream input) Parse a message of this type frominputand merge it with the message being built.mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry) Parse a message of this type frominputand merge it with the message being built.mergeUnknownFields(UnknownFieldSet unknownFields) Merge some unknown fields into theUnknownFieldSetfor this message.protected static UninitializedMessageExceptionnewUninitializedMessageException(Message message) Construct an UninitializedMessageException reporting missing fields in the given message.protected voidtoString()Methods 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
addRepeatedField, build, buildPartial, clearField, getDescriptorForType, mergeDelimitedFrom, mergeDelimitedFrom, newBuilderForField, setField, setRepeatedField, setUnknownFieldsMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
getAllFields, getDefaultInstanceForType, getField, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
clone
Description copied from interface:MessageLite.BuilderClones the Builder.- Specified by:
clonein interfaceMessage.Builder- Specified by:
clonein interfaceMessageLite.Builder- Specified by:
clonein classAbstractMessageLite.Builder- See Also:
-
hasOneof
TODO: Clear it when all subclasses have implemented this method.- Specified by:
hasOneofin interfaceMessageOrBuilder
-
getOneofFieldDescriptor
TODO: Clear it when all subclasses have implemented this method.- Specified by:
getOneofFieldDescriptorin interfaceMessageOrBuilder
-
clearOneof
TODO: Clear it when all subclasses have implemented this method.- Specified by:
clearOneofin interfaceMessage.Builder
-
clear
Description copied from interface:MessageLite.BuilderResets all fields to their default values.- Specified by:
clearin interfaceMessage.Builder- Specified by:
clearin interfaceMessageLite.Builder
-
findInitializationErrors
Description copied from interface:MessageOrBuilderReturns a list of field paths (e.g. "foo.bar.baz") of required fields which are not set in this message. You should callMessageLiteOrBuilder.isInitialized()first to check if there are any missing fields, as that method is likely to be much faster than this one even when the message is fully-initialized.- Specified by:
findInitializationErrorsin interfaceMessageOrBuilder
-
getInitializationErrorString
Description copied from interface:MessageOrBuilderReturns a comma-delimited list of required fields which are not set in this message object. You should callMessageLiteOrBuilder.isInitialized()first to check if there are any missing fields, as that method is likely to be much faster than this one even when the message is fully-initialized.- Specified by:
getInitializationErrorStringin interfaceMessageOrBuilder
-
internalMergeFrom
- Specified by:
internalMergeFromin classAbstractMessageLite.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
-
mergeFrom
-
mergeFrom
Description copied from interface:MessageLite.BuilderParses a message of this type from the input and merges it with this message.Warning: This does not verify that all required fields are present in the input message. If you call
MessageLite.Builder.build()without setting all required fields, it will throw anUninitializedMessageException, which is aRuntimeExceptionand thus might not be caught. There are a few good ways to deal with this:- Call
MessageLiteOrBuilder.isInitialized()to verify that all required fields are set before building. - Use
buildPartial()to build, which ignores missing required fields.
Note: The caller should call
CodedInputStream.checkLastTagWas(int)after calling this to verify that the last tag seen was the appropriate end-group tag, or zero for EOF.- Specified by:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Overrides:
mergeFromin classAbstractMessageLite.Builder- Throws:
InvalidProtocolBufferException- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.IOException- an I/O error reading from the stream
- Call
-
mergeFrom
public BuilderType mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from interface:MessageLite.BuilderLikeMessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered inextensionRegistry. Extensions not in the registry will be treated as unknown fields.- Specified by:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Specified by:
mergeFromin classAbstractMessageLite.Builder- Throws:
InvalidProtocolBufferException- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.IOException- an I/O error reading from the stream
-
getUnknownFieldSetBuilder
-
setUnknownFieldSetBuilder
-
mergeUnknownFields
Description copied from interface:Message.BuilderMerge some unknown fields into theUnknownFieldSetfor this message.- Specified by:
mergeUnknownFieldsin interfaceMessage.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
-
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
-
toString
-
newUninitializedMessageException
Construct an UninitializedMessageException reporting missing fields in the given message. -
markClean
void markClean()Used to support nested builders and called to mark this builder as clean. Clean builders will propagate theAbstractMessage.BuilderParent.markDirty()event to their parent builders, while dirty builders will not, as their parents should be dirty already.NOTE: Implementations that don't support nested builders don't need to override this method.
-
dispose
void dispose()Used to support nested builders and called when this nested builder is no longer used by its parent builder and should release the reference to its parent builder.NOTE: Implementations that don't support nested builders don't need to override this method.
-
mergeFrom
Description copied from interface:MessageLite.BuilderParsedataas a message of this type and merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream).- Specified by:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Overrides:
mergeFromin classAbstractMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes in data are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.
-
mergeFrom
public BuilderType mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Description copied from interface:MessageLite.BuilderParsedataas a message of this type and merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite).- Specified by:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Overrides:
mergeFromin classAbstractMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes in data are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.
-
mergeFrom
Description copied from interface:MessageLite.BuilderParsedataas a message of this type and merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream).- Specified by:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Overrides:
mergeFromin classAbstractMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes in data are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.
-
mergeFrom
Description copied from interface:MessageLite.BuilderParsedataas a message of this type and merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream).- Specified by:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Overrides:
mergeFromin classAbstractMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes in data are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.
-
mergeFrom
public BuilderType mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Description copied from interface:MessageLite.BuilderParsedataas a message of this type and merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite).- Specified by:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Overrides:
mergeFromin classAbstractMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes in data are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.
-
mergeFrom
public BuilderType mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Description copied from interface:MessageLite.BuilderParsedataas a message of this type and merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite).- Specified by:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Overrides:
mergeFromin classAbstractMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes in data are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.
-
mergeFrom
Description copied from interface:MessageLite.BuilderParse a message of this type frominputand merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream). Note that this method always reads the entire input (unless it throws an exception). If you want it to stop earlier, you will need to wrap your input in some wrapper stream that limits reading. Or, useMessageLite.writeDelimitedTo(OutputStream)to write your message andMessageLite.Builder.mergeDelimitedFrom(InputStream)to read it.Despite usually reading the entire input, this does not close the stream.
- Specified by:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Overrides:
mergeFromin classAbstractMessageLite.Builder- Returns:
- this
- Throws:
InvalidProtocolBufferException- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.IOException- an I/O error reading from the stream
-
mergeFrom
public BuilderType mergeFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from interface:MessageLite.BuilderParse a message of this type frominputand merge it with the message being built. This is just a small wrapper aroundMessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite).- Specified by:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Overrides:
mergeFromin classAbstractMessageLite.Builder- Returns:
- this
- Throws:
IOException
-