webkit  2cdf99a9e3038c7e01b3c37e8ad903ecbe5eecf1
https://github.com/WebKit/webkit
Classes | Public Member Functions | List of all members
com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder > Class Template Reference
Inheritance diagram for com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >:
com.google.protobuf.GeneratedMessage.BuilderParent

Public Member Functions

 RepeatedFieldBuilder (List< MType > messages, boolean isMessagesListMutable, GeneratedMessage.BuilderParent parent, boolean isClean)
 
void dispose ()
 
int getCount ()
 
boolean isEmpty ()
 
MType getMessage (int index)
 
BType getBuilder (int index)
 
IType getMessageOrBuilder (int index)
 
RepeatedFieldBuilder< MType, BType, IType > setMessage (int index, MType message)
 
RepeatedFieldBuilder< MType, BType, IType > addMessage (MType message)
 
RepeatedFieldBuilder< MType, BType, IType > addMessage (int index, MType message)
 
RepeatedFieldBuilder< MType, BType, IType > addAllMessages (Iterable<? extends MType > values)
 
BType addBuilder (MType message)
 
BType addBuilder (int index, MType message)
 
void remove (int index)
 
void clear ()
 
List< MType > build ()
 
List< MType > getMessageList ()
 
List< BType > getBuilderList ()
 
List< IType > getMessageOrBuilderList ()
 
void markDirty ()
 

Detailed Description

implements a structure that a protocol message uses to hold a repeated field of other protocol messages. It supports the classical use case of adding immutable Message's to the repeated field and is highly optimized around this (no extra memory allocations and sharing of immutable arrays).
It also supports the additional use case of adding a Message.Builder to the repeated field and deferring conversion of that

to an immutable

. In this way, it's possible to maintain a tree of

's that acts as a fully read/write data structure.
Logically, one can think of a tree of builders as converting the entire tree to messages when build is called on the root or when any method is called that desires a Message instead of a Builder. In terms of the implementation, the

SingleFieldBuilder

and

classes cache messages that were created so that messages only need to be created when some change occurred in its builder or a builder for one of its descendants.

Parameters
<MType>the type of message for the field
<BType>the type of builder for the field
<IType>the common interface for the message and the builder
Author
jonp@.nosp@m.goog.nosp@m.le.co.nosp@m.m (Jon Perlow)

Constructor & Destructor Documentation

◆ RepeatedFieldBuilder()

com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.RepeatedFieldBuilder ( List< MType >  messages,
boolean  isMessagesListMutable,
GeneratedMessage.BuilderParent  parent,
boolean  isClean 
)
inline

Constructs a new builder with an empty list of messages.

Parameters
messagesthe current list of messages
isMessagesListMutableWhether the messages list is mutable
parenta listener to notify of changes
isCleanwhether the builder is initially marked clean

Member Function Documentation

◆ addAllMessages()

RepeatedFieldBuilder<MType, BType, IType> com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.addAllMessages ( Iterable<? extends MType >  values)
inline

Appends all of the messages in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator.

Parameters
valuesthe messages to add
Returns
the builder

◆ addBuilder() [1/2]

BType com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.addBuilder ( MType  message)
inline

Appends a new builder to the end of this list and returns the builder.

Parameters
messagethe message to add which is the basis of the builder
Returns
the new builder

◆ addBuilder() [2/2]

BType com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.addBuilder ( int  index,
MType  message 
)
inline

Inserts a new builder at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters
indexthe index at which to insert the builder
messagethe message to add which is the basis of the builder
Returns
the builder

◆ addMessage() [1/2]

RepeatedFieldBuilder<MType, BType, IType> com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.addMessage ( MType  message)
inline

Appends the specified element to the end of this list.

Parameters
messagethe message to add
Returns
the builder

◆ addMessage() [2/2]

RepeatedFieldBuilder<MType, BType, IType> com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.addMessage ( int  index,
MType  message 
)
inline

Inserts the specified message at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters
indexthe index at which to insert the message
messagethe message to add
Returns
the builder

◆ build()

List<MType> com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.build ( )
inline

Builds the list of messages from the builder and returns them.

Returns
an immutable list of messages

◆ clear()

void com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.clear ( )
inline

Removes all of the elements from this list. The list will be empty after this call returns.

◆ dispose()

void com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.dispose ( )
inline

◆ getBuilder()

BType com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.getBuilder ( int  index)
inline

Gets a builder for the specified index. If no builder has been created for that index, a builder is created on demand by calling Message#toBuilder.

Parameters
indexthe index of the message to get
Returns
The builder for that index

◆ getBuilderList()

List<BType> com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.getBuilderList ( )
inline

Gets a view of the builder as a list of builders. This returned list is live and will reflect any changes to the underlying builder.

Returns
the builders in the list

◆ getCount()

int com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.getCount ( )
inline

Gets the count of items in the list.

Returns
the count of items in the list.

◆ getMessage()

MType com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.getMessage ( int  index)
inline

Get the message at the specified index. If the message is currently stored as a

, it is converted to a

by calling Message.Builder#buildPartial on it.

Parameters
indexthe index of the message to get
Returns
the message for the specified index

◆ getMessageList()

List<MType> com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.getMessageList ( )
inline

Gets a view of the builder as a list of messages. The returned list is live and will reflect any changes to the underlying builder.

Returns
the messages in the list

◆ getMessageOrBuilder()

IType com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.getMessageOrBuilder ( int  index)
inline

Gets the base class interface for the specified index. This may either be a builder or a message. It will return whatever is more efficient.

Parameters
indexthe index of the message to get
Returns
the message or builder for the index as the base class interface

◆ getMessageOrBuilderList()

List<IType> com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.getMessageOrBuilderList ( )
inline

Gets a view of the builder as a list of MessageOrBuilders. This returned list is live and will reflect any changes to the underlying builder.

Returns
the builders in the list

◆ isEmpty()

boolean com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.isEmpty ( void  )
inline

Gets whether the list is empty.

Returns
whether the list is empty

◆ markDirty()

void com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.markDirty ( )
inline

A builder becomes dirty whenever a field is modified – including fields in nested builders – and becomes clean when build() is called. Thus, when a builder becomes dirty, all its parents become dirty as well, and when it becomes clean, all its children become clean. The dirtiness state is used to invalidate certain cached values.
To this end, a builder calls markAsDirty() on its parent whenever it transitions from clean to dirty. The parent must propagate this call to its own parent, unless it was already dirty, in which case the grandparent must necessarily already be dirty as well. The parent can only transition back to "clean" after calling build() on all children.

Implements com.google.protobuf.GeneratedMessage.BuilderParent.

◆ remove()

void com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.remove ( int  index)
inline

Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Parameters
indexthe index at which to remove the message

◆ setMessage()

RepeatedFieldBuilder<MType, BType, IType> com.google.protobuf.RepeatedFieldBuilder< MType extends GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends MessageOrBuilder >.setMessage ( int  index,
MType  message 
)
inline

Sets a message at the specified index replacing the existing item at that index.

Parameters
indexthe index to set.
messagethe message to set
Returns
the builder

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