Protocol Buffers [Core] 3.7.1 · com.google.protobuf.SingleFieldBuilder

SingleFieldBuilder implements a structure that a protocol message uses to hold a single field of another protocol message. It supports the classical use case of setting an immutable Message as the value of the field and is highly optimized around this.

It also supports the additional use case of setting a Message.Builder as the 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.

Field Summary

Modifier and Type	Field and Description
private BType	builder
private boolean	isClean
private MType	message
private GeneratedMessage.BuilderParent	parent

Constructor Summary

Access	Constructor and Description
public	SingleFieldBuilder(MType message, GeneratedMessage.BuilderParent parent, boolean isClean)

Method Summary

Modifier and Type	Method and Description
public MType	Returns: the message build() Builds the message and returns it.
public SingleFieldBuilder<MType, BType, IType>	Returns: the builder clear() Clears the value of the field.
public void	dispose()
public BType	Returns: The builder for the field getBuilder() Gets a builder for the field.
public MType	Returns: the message for the field getMessage() Get the message for the field.
public IType	Returns: the message or builder for the field as the base class interface getMessageOrBuilder() Gets the base class interface for the field.
public void	markDirty() Implements com.google.protobuf.AbstractMessage.BuilderParent.markDirty. A builder becomes dirty whenever a field is modified -- including fields in nested builders -- and becomes clean when build() is called.
public SingleFieldBuilder<MType, BType, IType>	Returns: the builder mergeFrom(MType the value to merge from value) Merges the field from another field.
private void	onChanged() Called when a the builder or one of its nested children has changed and any parent should be notified of its invalidation.
public SingleFieldBuilder<MType, BType, IType>	Returns: the builder setMessage(MType the message to set message) Sets a message for the field replacing any existing value.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

builder	back to summary
private BType builder

isClean	back to summary
private boolean isClean

message	back to summary
private MType message

parent	back to summary
private GeneratedMessage.BuilderParent parent

Constructor Detail

SingleFieldBuilder	back to summary
public SingleFieldBuilder(MType message, GeneratedMessage.BuilderParent parent, boolean isClean)

Method Detail

build	back to summary
public MType build() Builds the message and returns it. Returns:MType the message

build

back to summary

public MType build()

Builds the message and returns it.

Returns:MType: the message

clear	back to summary
public SingleFieldBuilder<MType, BType, IType> clear() Clears the value of the field. Returns:SingleFieldBuilder<MType, BType, IType> the builder Annotations @SuppressWarnings:unchecked

clear

back to summary

public SingleFieldBuilder<MType, BType, IType> clear()

Clears the value of the field.

Returns:SingleFieldBuilder<MType, BType, IType>

the builder

Annotations

@SuppressWarnings:unchecked

dispose	back to summary
public void dispose()

getBuilder back to summary

getBuilder	back to summary
public BType getBuilder() Gets a builder for the field. If no builder has been created yet, a builder is created on demand by calling `Message#toBuilder`. Returns:BType The builder for the field Annotations @SuppressWarnings:unchecked

public BType getBuilder()

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

Returns:BType

The builder for the field

Annotations

@SuppressWarnings:unchecked

getMessage back to summary

getMessage	back to summary
public MType getMessage() Get the message for the field. If the message is currently stored as a `Builder`, it is converted to a `Message` by calling `Message.Builder#buildPartial` on it. If no message has been set, returns the default instance of the message. Returns:MType the message for the field Annotations @SuppressWarnings:unchecked

public MType getMessage()

Get the message for the field. If the message is currently stored as a Builder, it is converted to a Message by calling Message.Builder#buildPartial on it. If no message has been set, returns the default instance of the message.

Returns:MType

the message for the field

Annotations

@SuppressWarnings:unchecked

getMessageOrBuilder	back to summary
public IType getMessageOrBuilder() Gets the base class interface for the field. This may either be a builder or a message. It will return whatever is more efficient. Returns:IType the message or builder for the field as the base class interface Annotations @SuppressWarnings:unchecked

getMessageOrBuilder

back to summary

public IType getMessageOrBuilder()

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

Returns:IType

the message or builder for the field as the base class interface

Annotations

@SuppressWarnings:unchecked

markDirty	back to summary
public void markDirty() Implements com.google.protobuf.AbstractMessage.BuilderParent.markDirty. Doc from com.google.protobuf.AbstractMessage.BuilderParent.markDirty. 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. Annotations @Override

markDirty

back to summary

public void markDirty()

Implements com.google.protobuf.AbstractMessage.BuilderParent.markDirty.

Doc from com.google.protobuf.AbstractMessage.BuilderParent.markDirty.

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.

Annotations

@Override

mergeFrom	back to summary
public SingleFieldBuilder<MType, BType, IType> mergeFrom(MType value) Merges the field from another field. Parameters value:MType the value to merge from Returns:SingleFieldBuilder<MType, BType, IType> the builder

mergeFrom

back to summary

public SingleFieldBuilder<MType, BType, IType> mergeFrom(MType value)

Merges the field from another field.

Parameters

value:MType: the value to merge from

Returns:SingleFieldBuilder<MType, BType, IType>

the builder

onChanged	back to summary
private void onChanged() Called when a the builder or one of its nested children has changed and any parent should be notified of its invalidation.

setMessage	back to summary
public SingleFieldBuilder<MType, BType, IType> setMessage(MType message) Sets a message for the field replacing any existing value. Parameters message:MType the message to set Returns:SingleFieldBuilder<MType, BType, IType> the builder

setMessage

back to summary

public SingleFieldBuilder<MType, BType, IType> setMessage(MType message)

Sets a message for the field replacing any existing value.

Parameters

message:MType: the message to set

Returns:SingleFieldBuilder<MType, BType, IType>

the builder

public Class SingleFieldBuilder<MType extends com.google.protobuf.GeneratedMessage, BType extends GeneratedMessage.Builder, IType extends com.google.protobuf.MessageOrBuilder>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail