public static interface Message.Builder extends MessageLite.Builder, MessageOrBuilder
Modifier and Type | Method and Description |
---|---|
Message.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
java.lang.Object value)
Like
setRepeatedField , but appends the value as a new element. |
Message |
build()
Constructs the message based on the state of the Builder.
|
Message |
buildPartial()
Like
MessageLite.Builder.build() , but does not throw an exception if the message is missing required
fields. |
Message.Builder |
clear()
Resets all fields to their default values.
|
Message.Builder |
clearField(Descriptors.FieldDescriptor field)
Clears the field.
|
Message.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
Clears the oneof.
|
Message.Builder |
clone()
Clones the Builder.
|
Descriptors.Descriptor |
getDescriptorForType()
Get the message's type's descriptor.
|
Message.Builder |
getFieldBuilder(Descriptors.FieldDescriptor field)
Get a nested builder instance for the given field.
|
Message.Builder |
getRepeatedFieldBuilder(Descriptors.FieldDescriptor field,
int index)
Get a nested builder instance for the given repeated field instance.
|
boolean |
mergeDelimitedFrom(java.io.InputStream input)
Like
MessageLite.Builder.mergeFrom(InputStream) , but does not read until EOF. |
boolean |
mergeDelimitedFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry)
Like
MessageLite.Builder.mergeDelimitedFrom(InputStream) but supporting extensions. |
Message.Builder |
mergeFrom(byte[] data)
Parse
data as a message of this type and merge it with the message being built. |
Message.Builder |
mergeFrom(byte[] data,
ExtensionRegistryLite extensionRegistry)
Parse
data as a message of this type and merge it with the message being built. |
Message.Builder |
mergeFrom(byte[] data,
int off,
int len)
Parse
data as a message of this type and merge it with the message being built. |
Message.Builder |
mergeFrom(byte[] data,
int off,
int len,
ExtensionRegistryLite extensionRegistry)
Parse
data as a message of this type and merge it with the message being built. |
Message.Builder |
mergeFrom(ByteString data)
Parse
data as a message of this type and merge it with the message being built. |
Message.Builder |
mergeFrom(ByteString data,
ExtensionRegistryLite extensionRegistry)
Parse
data as a message of this type and merge it with the message being built. |
Message.Builder |
mergeFrom(CodedInputStream input)
Parses a message of this type from the input and merges it with this message.
|
Message.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry)
Like
MessageLite.Builder.mergeFrom(CodedInputStream) , but also parses extensions. |
Message.Builder |
mergeFrom(java.io.InputStream input)
Parse a message of this type from
input and merge it with the message being built. |
Message.Builder |
mergeFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry)
Parse a message of this type from
input and merge it with the message being built. |
Message.Builder |
mergeFrom(Message other)
Merge
other into the message being built. |
Message.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
Merge some unknown fields into the
UnknownFieldSet for this message. |
Message.Builder |
newBuilderForField(Descriptors.FieldDescriptor field)
Create a builder for messages of the appropriate type for the given field.
|
Message.Builder |
setField(Descriptors.FieldDescriptor field,
java.lang.Object value)
Sets a field to the given value.
|
Message.Builder |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
java.lang.Object value)
Sets an element of a repeated field to the given value.
|
Message.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
Set the
UnknownFieldSet for this message. |
mergeFrom
findInitializationErrors, getAllFields, getDefaultInstanceForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
isInitialized
Message.Builder clear()
MessageLite.Builder
clear
in interface MessageLite.Builder
Message.Builder mergeFrom(Message other)
other
into the message being built. other
must have the exact same type
as this
(i.e. getDescriptorForType() == other.getDescriptorForType()
).
Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set in other
, then other
's
value overwrites the value in this message.
* For singular message fields, if the field is set in other
, it is merged into the
corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements in other
are 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::MergeFrom
method in C++.
Message build()
MessageLite.Builder
build
in interface MessageLite.Builder
Message buildPartial()
MessageLite.Builder
MessageLite.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.buildPartial
in interface MessageLite.Builder
Message.Builder clone()
MessageLite.Builder
clone
in interface MessageLite.Builder
Object.clone()
Message.Builder mergeFrom(CodedInputStream input) throws java.io.IOException
MessageLite.Builder
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 an UninitializedMessageException
, which is a RuntimeException
and thus might not be
caught. There are a few good ways to deal with this:
MessageLiteOrBuilder.isInitialized()
to verify that all required fields are set before
building.
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.
mergeFrom
in interface MessageLite.Builder
java.io.IOException
Message.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
MessageLite.Builder
MessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions. The extensions
that you want to be able to parse must be registered in extensionRegistry
. Extensions
not in the registry will be treated as unknown fields.mergeFrom
in interface MessageLite.Builder
java.io.IOException
Descriptors.Descriptor getDescriptorForType()
MessageOrBuilder.getDescriptorForType()
.getDescriptorForType
in interface MessageOrBuilder
Message.Builder newBuilderForField(Descriptors.FieldDescriptor field)
setField(Descriptors.FieldDescriptor, Object)
,
setRepeatedField(Descriptors.FieldDescriptor, int, Object)
, or
addRepeatedField(Descriptors.FieldDescriptor, Object)
method of the current builder.
To obtain a builder nested in the current builder, use
getFieldBuilder(Descriptors.FieldDescriptor)
instead.
Message.Builder getFieldBuilder(Descriptors.FieldDescriptor 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
.
Message.Builder getRepeatedFieldBuilder(Descriptors.FieldDescriptor field, int index)
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
.
Message.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
MessageOrBuilder.getField(Descriptors.FieldDescriptor)
would return.Message.Builder clearField(Descriptors.FieldDescriptor field)
Message.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Message.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int)
would return.java.lang.IllegalArgumentException
- The field is not a repeated field, or field.getContainingType() != getDescriptorForType()
.Message.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
setRepeatedField
, but appends the value as a new element.java.lang.IllegalArgumentException
- The field is not a repeated field, or field.getContainingType() != getDescriptorForType()
.Message.Builder setUnknownFields(UnknownFieldSet unknownFields)
UnknownFieldSet
for this message.Message.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
UnknownFieldSet
for this message.Message.Builder mergeFrom(ByteString data) throws InvalidProtocolBufferException
MessageLite.Builder
data
as a message of this type and merge it with the message being built. This
is just a small wrapper around MessageLite.Builder.mergeFrom(CodedInputStream)
.mergeFrom
in interface MessageLite.Builder
InvalidProtocolBufferException
Message.Builder mergeFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageLite.Builder
data
as a message of this type and merge it with the message being built. This
is just a small wrapper around MessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)
.mergeFrom
in interface MessageLite.Builder
InvalidProtocolBufferException
Message.Builder mergeFrom(byte[] data) throws InvalidProtocolBufferException
MessageLite.Builder
data
as a message of this type and merge it with the message being built. This
is just a small wrapper around MessageLite.Builder.mergeFrom(CodedInputStream)
.mergeFrom
in interface MessageLite.Builder
InvalidProtocolBufferException
Message.Builder mergeFrom(byte[] data, int off, int len) throws InvalidProtocolBufferException
MessageLite.Builder
data
as a message of this type and merge it with the message being built. This
is just a small wrapper around MessageLite.Builder.mergeFrom(CodedInputStream)
.mergeFrom
in interface MessageLite.Builder
InvalidProtocolBufferException
Message.Builder mergeFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageLite.Builder
data
as a message of this type and merge it with the message being built. This
is just a small wrapper around MessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)
.mergeFrom
in interface MessageLite.Builder
InvalidProtocolBufferException
Message.Builder mergeFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageLite.Builder
data
as a message of this type and merge it with the message being built. This
is just a small wrapper around MessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)
.mergeFrom
in interface MessageLite.Builder
InvalidProtocolBufferException
Message.Builder mergeFrom(java.io.InputStream input) throws java.io.IOException
MessageLite.Builder
input
and merge it with the message being built.
This is just a small wrapper around MessageLite.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, use MessageLite.writeDelimitedTo(OutputStream)
to write your message and MessageLite.Builder.mergeDelimitedFrom(InputStream)
to read it.
Despite usually reading the entire input, this does not close the stream.
mergeFrom
in interface MessageLite.Builder
java.io.IOException
Message.Builder mergeFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
MessageLite.Builder
input
and merge it with the message being built.
This is just a small wrapper around MessageLite.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)
.mergeFrom
in interface MessageLite.Builder
java.io.IOException
boolean mergeDelimitedFrom(java.io.InputStream input) throws java.io.IOException
MessageLite.Builder
MessageLite.Builder.mergeFrom(InputStream)
, but does not read until EOF. Instead, the size of the
message (encoded as a varint) is read first, then the message data. Use MessageLite.writeDelimitedTo(OutputStream)
to write messages in this format.mergeDelimitedFrom
in interface MessageLite.Builder
java.io.IOException
boolean mergeDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
MessageLite.Builder
MessageLite.Builder.mergeDelimitedFrom(InputStream)
but supporting extensions.mergeDelimitedFrom
in interface MessageLite.Builder
java.io.IOException
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.