Class RepeatedFieldBuilder<MType,BType,IType> (3.19.4)
Stay organized with collections
Save and categorize content based on your preferences.
publicclass RepeatedFieldBuilder<MType,BType,IType>implementsGeneratedMessage.BuilderParentRepeatedFieldBuilder 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 Builder to an immutable Message. In this
way, it's possible to maintain a tree of Builder'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
RepeatedFieldBuilder 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.
Implements
GeneratedMessage.BuilderParentInherited Members
Type Parameters |
|
|---|---|
| Name | Description |
MType |
|
BType |
|
IType |
|
Constructors
RepeatedFieldBuilder(List<MType> messages, boolean isMessagesListMutable, GeneratedMessage.BuilderParent parent, boolean isClean)
publicRepeatedFieldBuilder(List<MType>messages,booleanisMessagesListMutable,GeneratedMessage.BuilderParentparent,booleanisClean)Constructs a new builder with an empty list of messages.
| Parameters | |
|---|---|
| Name | Description |
messages |
List<MType>the current list of messages |
isMessagesListMutable |
boolean Whether the messages list is mutable |
parent |
GeneratedMessage.BuilderParent a listener to notify of changes |
isClean |
boolean whether the builder is initially marked clean |
Methods
addAllMessages(Iterable<? extends MType> values)
publicRepeatedFieldBuilder<MType,BType,IType>addAllMessages(Iterable<?extendsMType>values)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.
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends MType>the messages to add |
| Returns | |
|---|---|
| Type | Description |
RepeatedFieldBuilder<MType,BType,IType> |
the builder |
addBuilder(MType message)
publicBTypeaddBuilder(MTypemessage)Appends a new builder to the end of this list and returns the builder.
| Parameter | |
|---|---|
| Name | Description |
message |
MTypethe message to add which is the basis of the builder |
| Returns | |
|---|---|
| Type | Description |
BType |
the new builder |
addBuilder(int index, MType message)
publicBTypeaddBuilder(intindex,MTypemessage)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 | |
|---|---|
| Name | Description |
index |
int the index at which to insert the builder |
message |
MTypethe message to add which is the basis of the builder |
| Returns | |
|---|---|
| Type | Description |
BType |
the builder |
addMessage(MType message)
publicRepeatedFieldBuilder<MType,BType,IType>addMessage(MTypemessage)Appends the specified element to the end of this list.
| Parameter | |
|---|---|
| Name | Description |
message |
MTypethe message to add |
| Returns | |
|---|---|
| Type | Description |
RepeatedFieldBuilder<MType,BType,IType> |
the builder |
addMessage(int index, MType message)
publicRepeatedFieldBuilder<MType,BType,IType>addMessage(intindex,MTypemessage)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 | |
|---|---|
| Name | Description |
index |
int the index at which to insert the message |
message |
MTypethe message to add |
| Returns | |
|---|---|
| Type | Description |
RepeatedFieldBuilder<MType,BType,IType> |
the builder |
build()
publicList<MType>build()Builds the list of messages from the builder and returns them.
| Returns | |
|---|---|
| Type | Description |
List<MType> |
an immutable list of messages |
clear()
publicvoidclear()Removes all of the elements from this list. The list will be empty after this call returns.
dispose()
publicvoiddispose()getBuilder(int index)
publicBTypegetBuilder(intindex)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.
| Parameter | |
|---|---|
| Name | Description |
index |
int the index of the message to get |
| Returns | |
|---|---|
| Type | Description |
BType |
The builder for that index |
getBuilderList()
publicList<BType>getBuilderList()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 | |
|---|---|
| Type | Description |
List<BType> |
the builders in the list |
getCount()
publicintgetCount()Gets the count of items in the list.
| Returns | |
|---|---|
| Type | Description |
int |
the count of items in the list. |
getMessage(int index)
publicMTypegetMessage(intindex)Get the message at the specified index. If the message is currently stored as a
Builder, it is converted to a Message by calling Message.Builder#buildPartial
on it.
| Parameter | |
|---|---|
| Name | Description |
index |
int the index of the message to get |
| Returns | |
|---|---|
| Type | Description |
MType |
the message for the specified index |
getMessageList()
publicList<MType>getMessageList()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 | |
|---|---|
| Type | Description |
List<MType> |
the messages in the list |
getMessageOrBuilder(int index)
publicITypegetMessageOrBuilder(intindex)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.
| Parameter | |
|---|---|
| Name | Description |
index |
int the index of the message to get |
| Returns | |
|---|---|
| Type | Description |
IType |
the message or builder for the index as the base class interface |
getMessageOrBuilderList()
publicList<IType>getMessageOrBuilderList()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 | |
|---|---|
| Type | Description |
List<IType> |
the builders in the list |
isEmpty()
publicbooleanisEmpty()Gets whether the list is empty.
| Returns | |
|---|---|
| Type | Description |
boolean |
whether the list is empty |
markDirty()
publicvoidmarkDirty()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 markDirty() 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.
remove(int index)
publicvoidremove(intindex)Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).
| Parameter | |
|---|---|
| Name | Description |
index |
int the index at which to remove the message |
setMessage(int index, MType message)
publicRepeatedFieldBuilder<MType,BType,IType>setMessage(intindex,MTypemessage)Sets a message at the specified index replacing the existing item at that index.
| Parameters | |
|---|---|
| Name | Description |
index |
int the index to set. |
message |
MTypethe message to set |
| Returns | |
|---|---|
| Type | Description |
RepeatedFieldBuilder<MType,BType,IType> |
the builder |