|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface Message.Builder
Abstract interface implemented by Protocol Message builders.
Method Summary | |
---|---|
Message.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
java.lang.Object value)
Like setRepeatedField , but appends the value as a new element. |
Message |
build()
Construct the final message. |
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 |
clone()
Clones the Builder. |
java.util.Map<Descriptors.FieldDescriptor,java.lang.Object> |
getAllFields()
Like Message.getAllFields() . |
Message |
getDefaultInstanceForType()
Get the message's type's default instance. |
Descriptors.Descriptor |
getDescriptorForType()
Get the message's type's descriptor. |
java.lang.Object |
getField(Descriptors.FieldDescriptor field)
Like Message.getField(Descriptors.FieldDescriptor) |
java.lang.Object |
getRepeatedField(Descriptors.FieldDescriptor field,
int index)
Like Message.getRepeatedField(Descriptors.FieldDescriptor,int) |
int |
getRepeatedFieldCount(Descriptors.FieldDescriptor field)
Like Message.getRepeatedFieldCount(Descriptors.FieldDescriptor) |
UnknownFieldSet |
getUnknownFields()
Get the UnknownFieldSet for this message. |
boolean |
hasField(Descriptors.FieldDescriptor field)
Like Message.hasField(Descriptors.FieldDescriptor) |
Message.Builder |
mergeDelimitedFrom(java.io.InputStream input)
Like MessageLite.Builder.mergeFrom(InputStream) , but does not read until EOF. |
Message.Builder |
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, as if using Builder#mergeFrom(MessageLite) . |
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. |
Methods inherited from interface com.google.protobuf.MessageLite.Builder |
---|
isInitialized |
Method Detail |
---|
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:other
,
then other
's value overwrites the value in this message.other
,
it is merged into the corresponding sub-message of this message
using the same merging rules.other
are concatenated
with the elements in this message.
This is equivalent to the Message::MergeFrom
method in C++.
Message build()
MessageLite.Builder
build()
, clone()
it first.
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.
Once this is called, the Builder is no longer valid, and calling any
will result in undefined behavior and may throw a NullPointerException.
If you need to continue working with the builder after calling
buildPartial()
, clone()
it first.
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
Builder#mergeFrom(MessageLite)
.
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:
MessageLite.Builder.isInitialized()
to verify that all required fields
are set before building.
parseFrom
methods, then use #mergeFrom(MessageLite)
to merge it with this one. parseFrom
will throw an
InvalidProtocolBufferException
(an IOException
)
if some required fields are missing.
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()
Message.getDescriptorForType()
.
Message getDefaultInstanceForType()
MessageLite.Builder
MessageLite.getDefaultInstanceForType()
.
getDefaultInstanceForType
in interface MessageLite.Builder
java.util.Map<Descriptors.FieldDescriptor,java.lang.Object> getAllFields()
Message.getAllFields()
. The returned map may or may not
reflect future changes to the builder. Either way, the returned map is
itself unmodifiable.
Message.Builder newBuilderForField(Descriptors.FieldDescriptor field)
boolean hasField(Descriptors.FieldDescriptor field)
Message.hasField(Descriptors.FieldDescriptor)
java.lang.Object getField(Descriptors.FieldDescriptor field)
Message.getField(Descriptors.FieldDescriptor)
Message.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
Message.getField(Descriptors.FieldDescriptor)
would return.
Message.Builder clearField(Descriptors.FieldDescriptor field)
int getRepeatedFieldCount(Descriptors.FieldDescriptor field)
Message.getRepeatedFieldCount(Descriptors.FieldDescriptor)
java.lang.Object getRepeatedField(Descriptors.FieldDescriptor field, int index)
Message.getRepeatedField(Descriptors.FieldDescriptor,int)
Message.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Message.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()
.UnknownFieldSet getUnknownFields()
UnknownFieldSet
for this message.
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
#mergeFrom(CodedInputStream,ExtensionRegistry)
.
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
#mergeFrom(CodedInputStream,ExtensionRegistry)
.
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
#mergeFrom(CodedInputStream,ExtensionRegistry)
.
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
#mergeFrom(CodedInputStream,ExtensionRegistry)
.
mergeFrom
in interface MessageLite.Builder
java.io.IOException
Message.Builder 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
Message.Builder 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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |