Class Struct.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<Struct.Builder>

com.google.protobuf.GeneratedMessage.Builder<Struct.Builder>

com.google.protobuf.Struct.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, StructOrBuilder, Cloneable

Enclosing class:

Struct

public static final class Struct.Builder
extends GeneratedMessage.Builder<Struct.Builder>
implements StructOrBuilder

`Struct` represents a structured data value, consisting of fields
which map to dynamically typed values. In some languages, `Struct`
might be supported by a native representation. For example, in
scripting languages like JS a struct is represented as an
object. The details of that representation are described together
with the proto support for the language.

The JSON representation for `Struct` is JSON object.

Protobuf type google.protobuf.Struct

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	Struct.Builder.FieldsConverter

Nested classes/interfaces inherited from class AbstractMessageLite.Builder

AbstractMessageLite.Builder.LimitedInputStream

Field Summary

Fields

Modifier and Type	Field	Description
private int	bitField0_
private MapFieldBuilder<String, ValueOrBuilder, Value, Value.Builder>	fields_
private static final Struct.Builder.FieldsConverter	fieldsConverter

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder()
private	Builder(AbstractMessage.BuilderParent parent)

Method Summary

Modifier and Type	Method	Description
Struct	build()	Constructs the message based on the state of the Builder.
Struct	buildPartial()	Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields.
private void	buildPartial0(Struct result)
Struct.Builder	clear()	Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
Struct.Builder	clearFields()
boolean	containsFields(String key)	Unordered map of dynamically typed values.
Struct	getDefaultInstanceForType()	Get an instance of the type with no fields set.
static final Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()	Get the message's type's descriptor.
Map<String,Value>	getFields()	Deprecated.
int	getFieldsCount()	Unordered map of dynamically typed values.
Map<String,Value>	getFieldsMap()	Unordered map of dynamically typed values.
Value	getFieldsOrDefault(String key, Value defaultValue)	Unordered map of dynamically typed values.
Value	getFieldsOrThrow(String key)	Unordered map of dynamically typed values.
Map<String,Value>	getMutableFields()	Deprecated.
protected GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
private MapFieldBuilder<String, ValueOrBuilder, Value, Value.Builder>	internalGetFields()
protected MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)	Gets the map field with the given field number.
private MapFieldBuilder<String, ValueOrBuilder, Value, Value.Builder>	internalGetMutableFields()
protected MapFieldReflectionAccessor	internalGetMutableMapFieldReflection(int number)	Like GeneratedMessage.Builder.internalGetMapFieldReflection(int) but return a mutable version.
final boolean	isInitialized()	Returns true if all required fields in the message and all embedded messages are set, false otherwise.
Struct.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)	Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.
Struct.Builder	mergeFrom(Message other)	Merge other into the message being built.
Struct.Builder	mergeFrom(Struct other)
Struct.Builder	putAllFields(Map<String,Value> values)	Unordered map of dynamically typed values.
Struct.Builder	putFields(String key, Value value)	Unordered map of dynamically typed values.
Value.Builder	putFieldsBuilderIfAbsent(String key)	Unordered map of dynamically typed values.
Struct.Builder	removeFields(String key)	Unordered map of dynamically typed values.

Methods inherited from class GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, dispose, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface MessageLite.Builder

mergeFrom

Methods inherited from interface MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

bitField0_

private int bitField0_

fieldsConverter

private static final Struct.Builder.FieldsConverter fieldsConverter

fields_

private MapFieldBuilder<String, ValueOrBuilder, Value, Value.Builder> fields_

Constructor Details

Builder

private Builder()

Builder

private Builder(AbstractMessage.BuilderParent parent)

Method Details

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Description copied from class: GeneratedMessage.Builder

Gets the map field with the given field number. This method should be overridden in the generated message class if the message contains map fields.

Unlike other field types, reflection support for map fields can't be implemented based on generated public API because we need to access a map field as a list in reflection API but the generated API only allows us to access it as a map. This method returns the underlying map field directly and thus enables us to access the map field as a list.

Overrides:

internalGetMapFieldReflection in class GeneratedMessage.Builder<Struct.Builder>

internalGetMutableMapFieldReflection

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Description copied from class: GeneratedMessage.Builder

Like GeneratedMessage.Builder.internalGetMapFieldReflection(int) but return a mutable version.

Overrides:

internalGetMutableMapFieldReflection in class GeneratedMessage.Builder<Struct.Builder>

internalGetFieldAccessorTable

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Description copied from class: GeneratedMessage.Builder

Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.

Specified by:

internalGetFieldAccessorTable in class GeneratedMessage.Builder<Struct.Builder>

clear

public Struct.Builder clear()

Description copied from class: GeneratedMessage.Builder

Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessage.Builder<Struct.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Description copied from interface: Message.Builder

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

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessage.Builder<Struct.Builder>

getDefaultInstanceForType

public Struct getDefaultInstanceForType()

Description copied from interface: MessageLiteOrBuilder

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public Struct build()

Description copied from interface: MessageLite.Builder

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

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public Struct buildPartial()

Description copied from interface: MessageLite.Builder

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

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

buildPartial0

private void buildPartial0(Struct result)

mergeFrom

public Struct.Builder mergeFrom(Message other)

Description copied from interface: Message.Builder

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 Message::MergeFrom method in C++.

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Struct.Builder>

mergeFrom

public Struct.Builder mergeFrom(Struct other)

isInitialized

public final boolean isInitialized()

Description copied from interface: MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage.Builder<Struct.Builder>

mergeFrom

public Struct.Builder mergeFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                         throws IOException

Description copied from interface: MessageLite.Builder

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

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Struct.Builder>

Throws:

IOException - an I/O error reading from the stream

internalGetFields

private MapFieldBuilder<String, ValueOrBuilder, Value, Value.Builder> internalGetFields()

internalGetMutableFields

private MapFieldBuilder<String, ValueOrBuilder, Value, Value.Builder> internalGetMutableFields()

getFieldsCount

public int getFieldsCount()

Description copied from interface: StructOrBuilder

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;

Specified by:

getFieldsCount in interface StructOrBuilder

containsFields

public boolean containsFields(String key)

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;

Specified by:

containsFields in interface StructOrBuilder

getFields

@Deprecated
public Map<String,Value> getFields()

Deprecated.

Use getFieldsMap() instead.

Specified by:

getFields in interface StructOrBuilder

getFieldsMap

public Map<String,Value> getFieldsMap()

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;

Specified by:

getFieldsMap in interface StructOrBuilder

getFieldsOrDefault

public Value getFieldsOrDefault(String key,
 Value defaultValue)

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;

Specified by:

getFieldsOrDefault in interface StructOrBuilder

getFieldsOrThrow

public Value getFieldsOrThrow(String key)

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;

Specified by:

getFieldsOrThrow in interface StructOrBuilder

clearFields

public Struct.Builder clearFields()

removeFields

public Struct.Builder removeFields(String key)

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;

getMutableFields

@Deprecated
public Map<String,Value> getMutableFields()

Deprecated.

Use alternate mutation accessors instead.

putFields

public Struct.Builder putFields(String key,
 Value value)

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;

putAllFields

public Struct.Builder putAllFields(Map<String,Value> values)

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;

putFieldsBuilderIfAbsent

public Value.Builder putFieldsBuilderIfAbsent(String key)

Unordered map of dynamically typed values.

map<string, .google.protobuf.Value> fields = 1;