webkit  2cdf99a9e3038c7e01b3c37e8ad903ecbe5eecf1
https://github.com/WebKit/webkit
Public Member Functions | List of all members
com.google.protobuf.Message.Builder Interface Reference
Inheritance diagram for com.google.protobuf.Message.Builder:
com.google.protobuf.MessageLite.Builder com.google.protobuf.MessageOrBuilder com.google.protobuf.MessageLiteOrBuilder com.google.protobuf.MessageLiteOrBuilder

Public Member Functions

Builder clear ()
 
Builder mergeFrom (Message other)
 
Message build ()
 
Message buildPartial ()
 
Builder clone ()
 
Builder mergeFrom (CodedInputStream input) throws IOException
 
Builder mergeFrom (CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
 
Descriptors.Descriptor getDescriptorForType ()
 
Builder newBuilderForField (Descriptors.FieldDescriptor field)
 
Builder getFieldBuilder (Descriptors.FieldDescriptor field)
 
Builder getRepeatedFieldBuilder (Descriptors.FieldDescriptor field, int index)
 
Builder setField (Descriptors.FieldDescriptor field, Object value)
 
Builder clearField (Descriptors.FieldDescriptor field)
 
Builder clearOneof (Descriptors.OneofDescriptor oneof)
 
Builder setRepeatedField (Descriptors.FieldDescriptor field, int index, Object value)
 
Builder addRepeatedField (Descriptors.FieldDescriptor field, Object value)
 
Builder setUnknownFields (UnknownFieldSet unknownFields)
 
Builder mergeUnknownFields (UnknownFieldSet unknownFields)
 
Builder mergeFrom (ByteString data) throws InvalidProtocolBufferException
 
Builder mergeFrom (ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
 
Builder mergeFrom (byte[] data) throws InvalidProtocolBufferException
 
Builder mergeFrom (byte[] data, int off, int len) throws InvalidProtocolBufferException
 
Builder mergeFrom (byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
 
Builder mergeFrom (byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
 
Builder mergeFrom (InputStream input) throws IOException
 
Builder mergeFrom (InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
 
boolean mergeDelimitedFrom (InputStream input) throws IOException
 
boolean mergeDelimitedFrom (InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
 
- Public Member Functions inherited from com.google.protobuf.MessageLite.Builder
Builder mergeFrom (MessageLite other)
 
- Public Member Functions inherited from com.google.protobuf.MessageLiteOrBuilder
boolean isInitialized ()
 
- Public Member Functions inherited from com.google.protobuf.MessageOrBuilder
Message getDefaultInstanceForType ()
 
List< String > findInitializationErrors ()
 
String getInitializationErrorString ()
 
Map< Descriptors.FieldDescriptor, ObjectgetAllFields ()
 
boolean hasOneof (Descriptors.OneofDescriptor oneof)
 
Descriptors.FieldDescriptor getOneofFieldDescriptor (Descriptors.OneofDescriptor oneof)
 
boolean hasField (Descriptors.FieldDescriptor field)
 
Object getField (Descriptors.FieldDescriptor field)
 
int getRepeatedFieldCount (Descriptors.FieldDescriptor field)
 
Object getRepeatedField (Descriptors.FieldDescriptor field, int index)
 
UnknownFieldSet getUnknownFields ()
 

Detailed Description

Abstract interface implemented by Protocol Message builders.

Member Function Documentation

◆ addRepeatedField()

Builder com.google.protobuf.Message.Builder.addRepeatedField ( Descriptors.FieldDescriptor  field,
Object  value 
)

Like

, but appends the value as a new element.

Exceptions
IllegalArgumentExceptionThe field is not a repeated field, or
field.getContainingType() != getDescriptorForType()
.

◆ build()

Message com.google.protobuf.Message.Builder.build ( )

Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.

Exceptions
UninitializedMessageExceptionThe message is missing one or more required fields (i.e. isInitialized() returns false). Use buildPartial() to bypass this check.

Implements com.google.protobuf.MessageLite.Builder.

◆ buildPartial()

Message com.google.protobuf.Message.Builder.buildPartial ( )

Like 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.

Implements com.google.protobuf.MessageLite.Builder.

◆ clear()

Builder com.google.protobuf.Message.Builder.clear ( )

Resets all fields to their default values.

Implements com.google.protobuf.MessageLite.Builder.

◆ clearField()

Builder com.google.protobuf.Message.Builder.clearField ( Descriptors.FieldDescriptor  field)

Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.

◆ clearOneof()

Builder com.google.protobuf.Message.Builder.clearOneof ( Descriptors.OneofDescriptor  oneof)

Clears the oneof. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the oneof.

◆ clone()

Builder com.google.protobuf.Message.Builder.clone ( )

◆ getDescriptorForType()

Descriptors.Descriptor com.google.protobuf.Message.Builder.getDescriptorForType ( )

Get the message's type's descriptor. See Message#getDescriptorForType().

Implements com.google.protobuf.MessageOrBuilder.

◆ getFieldBuilder()

Builder com.google.protobuf.Message.Builder.getFieldBuilder ( Descriptors.FieldDescriptor  field)

Get 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), 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.

◆ getRepeatedFieldBuilder()

Builder com.google.protobuf.Message.Builder.getRepeatedFieldBuilder ( Descriptors.FieldDescriptor  field,
int  index 
)

Get 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), 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.

◆ mergeDelimitedFrom() [1/2]

boolean com.google.protobuf.Message.Builder.mergeDelimitedFrom ( InputStream  input) throws IOException

Like 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.

Returns
True if successful, or false if the stream is at EOF when the method starts. Any other error (including reaching EOF during parsing) will cause an exception to be thrown.

Implements com.google.protobuf.MessageLite.Builder.

◆ mergeDelimitedFrom() [2/2]

boolean com.google.protobuf.Message.Builder.mergeDelimitedFrom ( InputStream  input,
ExtensionRegistryLite  extensionRegistry 
) throws IOException

Like mergeDelimitedFrom(InputStream) but supporting extensions.

Implements com.google.protobuf.MessageLite.Builder.

◆ mergeFrom() [1/11]

Builder com.google.protobuf.Message.Builder.mergeFrom ( Message  other)

Merge

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

method in C++.

◆ mergeFrom() [2/11]

Builder com.google.protobuf.Message.Builder.mergeFrom ( CodedInputStream  input) throws IOException

Parses 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 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:

  • Call isInitialized() to verify that all required fields are set before building.
  • Use 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.

Implements com.google.protobuf.MessageLite.Builder.

◆ mergeFrom() [3/11]

Builder com.google.protobuf.Message.Builder.mergeFrom ( CodedInputStream  input,
ExtensionRegistryLite  extensionRegistry 
) throws IOException

Like 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.

Implements com.google.protobuf.MessageLite.Builder.

◆ mergeFrom() [4/11]

Builder com.google.protobuf.Message.Builder.mergeFrom ( ByteString  data) throws InvalidProtocolBufferException

Parse

as a message of this type and merge it with the message being built. This is just a small wrapper around mergeFrom(CodedInputStream).

Returns
this

Implements com.google.protobuf.MessageLite.Builder.

◆ mergeFrom() [5/11]

Builder com.google.protobuf.Message.Builder.mergeFrom ( ByteString  data,
ExtensionRegistryLite  extensionRegistry 
) throws InvalidProtocolBufferException

Parse

as a message of this type and merge it with the message being built. This is just a small wrapper around mergeFrom(CodedInputStream,ExtensionRegistryLite).

Returns
this

Implements com.google.protobuf.MessageLite.Builder.

◆ mergeFrom() [6/11]

Builder com.google.protobuf.Message.Builder.mergeFrom ( byte []  data) throws InvalidProtocolBufferException

Parse

as a message of this type and merge it with the message being built. This is just a small wrapper around mergeFrom(CodedInputStream).

Returns
this

Implements com.google.protobuf.MessageLite.Builder.

◆ mergeFrom() [7/11]

Builder com.google.protobuf.Message.Builder.mergeFrom ( byte []  data,
int  off,
int  len 
) throws InvalidProtocolBufferException

Parse

as a message of this type and merge it with the message being built. This is just a small wrapper around mergeFrom(CodedInputStream).

Returns
this

Implements com.google.protobuf.MessageLite.Builder.

◆ mergeFrom() [8/11]

Builder com.google.protobuf.Message.Builder.mergeFrom ( byte []  data,
ExtensionRegistryLite  extensionRegistry 
) throws InvalidProtocolBufferException

Parse

as a message of this type and merge it with the message being built. This is just a small wrapper around mergeFrom(CodedInputStream,ExtensionRegistryLite).

Returns
this

Implements com.google.protobuf.MessageLite.Builder.

◆ mergeFrom() [9/11]

Builder com.google.protobuf.Message.Builder.mergeFrom ( byte []  data,
int  off,
int  len,
ExtensionRegistryLite  extensionRegistry 
) throws InvalidProtocolBufferException

Parse

as a message of this type and merge it with the message being built. This is just a small wrapper around mergeFrom(CodedInputStream,ExtensionRegistryLite).

Returns
this

Implements com.google.protobuf.MessageLite.Builder.

◆ mergeFrom() [10/11]

Builder com.google.protobuf.Message.Builder.mergeFrom ( InputStream  input) throws IOException

Parse a message of this type from

and merge it with the message being built. This is just a small wrapper around 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 mergeDelimitedFrom(InputStream) to read it.

Despite usually reading the entire input, this does not close the stream.

Returns
this

Implements com.google.protobuf.MessageLite.Builder.

◆ mergeFrom() [11/11]

Builder com.google.protobuf.Message.Builder.mergeFrom ( InputStream  input,
ExtensionRegistryLite  extensionRegistry 
) throws IOException

Parse a message of this type from

and merge it with the message being built. This is just a small wrapper around mergeFrom(CodedInputStream,ExtensionRegistryLite).

Returns
this

Implements com.google.protobuf.MessageLite.Builder.

◆ mergeUnknownFields()

Builder com.google.protobuf.Message.Builder.mergeUnknownFields ( UnknownFieldSet  unknownFields)

Merge some unknown fields into the UnknownFieldSet for this message.

◆ newBuilderForField()

Builder com.google.protobuf.Message.Builder.newBuilderForField ( Descriptors.FieldDescriptor  field)

Create a Builder for messages of the appropriate type for the given field. Messages built with this can then be passed to setField(), setRepeatedField(), or addRepeatedField().

◆ setField()

Builder com.google.protobuf.Message.Builder.setField ( Descriptors.FieldDescriptor  field,
Object  value 
)

Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type that Message#getField(Descriptors.FieldDescriptor) would return.

◆ setRepeatedField()

Builder com.google.protobuf.Message.Builder.setRepeatedField ( Descriptors.FieldDescriptor  field,
int  index,
Object  value 
)

Sets an element of a repeated field to the given value. The value must be of the correct type for this field, i.e. the same type that Message#getRepeatedField(Descriptors.FieldDescriptor,int) would return.

Exceptions
IllegalArgumentExceptionThe field is not a repeated field, or
field.getContainingType() != getDescriptorForType()
.

◆ setUnknownFields()

Builder com.google.protobuf.Message.Builder.setUnknownFields ( UnknownFieldSet  unknownFields)

Set the UnknownFieldSet for this message.


The documentation for this interface was generated from the following file: