Value.Builder (Protocol Buffers [Core] 3.14.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Value.Builder>
    - - com.google.protobuf.Value.Builder

All Implemented Interfaces:: Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, ValueOrBuilder, Cloneable

Enclosing class:: Value

public static final class Value.Builder
extends GeneratedMessageV3.Builder<Value.Builder>
implements ValueOrBuilder

 `Value` represents a dynamically typed value which can be either
 null, a number, a string, a boolean, a recursive struct value, or a
 list of values. A producer of value is expected to set one of that
 variants, absence of any variant indicates an error.
 The JSON representation for `Value` is JSON value.

Protobuf type google.protobuf.Value

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Value.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, Object value)` Like `setRepeatedField`, but appends the value as a new element.
`Value`	`build()` Constructs the message based on the state of the Builder.
`Value`	`buildPartial()` Like `MessageLite.Builder.build()`, but does not throw an exception if the message is missing required fields.
`Value.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.
`Value.Builder`	`clearBoolValue()` Represents a boolean value.
`Value.Builder`	`clearField(Descriptors.FieldDescriptor field)` Clears the field.
`Value.Builder`	`clearKind()`
`Value.Builder`	`clearListValue()` Represents a repeated `Value`.
`Value.Builder`	`clearNullValue()` Represents a null value.
`Value.Builder`	`clearNumberValue()` Represents a double value.
`Value.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)` TODO(jieluo): Clear it when all subclasses have implemented this method.
`Value.Builder`	`clearStringValue()` Represents a string value.
`Value.Builder`	`clearStructValue()` Represents a structured value.
`Value.Builder`	`clone()` Clones the Builder.
`boolean`	`getBoolValue()` Represents a boolean value.
`Value`	`getDefaultInstanceForType()` Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()` Get the message's type's descriptor.
`Value.KindCase`	`getKindCase()`
`ListValue`	`getListValue()` Represents a repeated `Value`.
`ListValue.Builder`	`getListValueBuilder()` Represents a repeated `Value`.
`ListValueOrBuilder`	`getListValueOrBuilder()` Represents a repeated `Value`.
`NullValue`	`getNullValue()` Represents a null value.
`int`	`getNullValueValue()` Represents a null value.
`double`	`getNumberValue()` Represents a double value.
`String`	`getStringValue()` Represents a string value.
`ByteString`	`getStringValueBytes()` Represents a string value.
`Struct`	`getStructValue()` Represents a structured value.
`Struct.Builder`	`getStructValueBuilder()` Represents a structured value.
`StructOrBuilder`	`getStructValueOrBuilder()` Represents a structured value.
`boolean`	`hasListValue()` Represents a repeated `Value`.
`boolean`	`hasStructValue()` Represents a structured value.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()` Get the FieldAccessorTable for this type.
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`Value.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)` Like `MessageLite.Builder.mergeFrom(CodedInputStream)`, but also parses extensions.
`Value.Builder`	`mergeFrom(Message other)` Merge `other` into the message being built.
`Value.Builder`	`mergeFrom(Value other)`
`Value.Builder`	`mergeListValue(ListValue value)` Represents a repeated `Value`.
`Value.Builder`	`mergeStructValue(Struct value)` Represents a structured value.
`Value.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)` Merge some unknown fields into the `UnknownFieldSet` for this message.
`Value.Builder`	`setBoolValue(boolean value)` Represents a boolean value.
`Value.Builder`	`setField(Descriptors.FieldDescriptor field, Object value)` Sets a field to the given value.
`Value.Builder`	`setListValue(ListValue.Builder builderForValue)` Represents a repeated `Value`.
`Value.Builder`	`setListValue(ListValue value)` Represents a repeated `Value`.
`Value.Builder`	`setNullValue(NullValue value)` Represents a null value.
`Value.Builder`	`setNullValueValue(int value)` Represents a null value.
`Value.Builder`	`setNumberValue(double value)` Represents a double value.
`Value.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)` Sets an element of a repeated field to the given value.
`Value.Builder`	`setStringValue(String value)` Represents a string value.
`Value.Builder`	`setStringValueBytes(ByteString value)` Represents a string value.
`Value.Builder`	`setStructValue(Struct.Builder builderForValue)` Represents a structured value.
`Value.Builder`	`setStructValue(Struct value)` Represents a structured value.
`Value.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)` Set the `UnknownFieldSet` for this message.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Description copied from class: GeneratedMessageV3.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 GeneratedMessageV3.Builder<Value.Builder>
  - clear
```
public Value.Builder clear()
```
    Description copied from class: GeneratedMessageV3.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 GeneratedMessageV3.Builder<Value.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 GeneratedMessageV3.Builder<Value.Builder>
  - getDefaultInstanceForType
```
public Value 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 Value 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 Value 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
  - clone
```
public Value.Builder clone()
```
    Description copied from interface: MessageLite.Builder
    
    Clones the Builder.
    
    Specified by:
    
    clone in interface Message.Builder
    
    Specified by:
    
    clone in interface MessageLite.Builder
    
    Overrides:
    
    clone in class GeneratedMessageV3.Builder<Value.Builder>
    
    See Also:
    
    Object.clone()
  - setField
```
public Value.Builder setField(Descriptors.FieldDescriptor field,
                              Object value)
```
    Description copied from interface: Message.Builder
    
    Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getField(Descriptors.FieldDescriptor) would return.
    
    Specified by:
    
    setField in interface Message.Builder
    
    Overrides:
    
    setField in class GeneratedMessageV3.Builder<Value.Builder>
  - clearField
```
public Value.Builder clearField(Descriptors.FieldDescriptor field)
```
    Description copied from interface: Message.Builder
    
    Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.
    
    Specified by:
    
    clearField in interface Message.Builder
    
    Overrides:
    
    clearField in class GeneratedMessageV3.Builder<Value.Builder>
  - clearOneof
```
public Value.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
    Description copied from class: AbstractMessage.Builder
    
    TODO(jieluo): Clear it when all subclasses have implemented this method.
    
    Specified by:
    
    clearOneof in interface Message.Builder
    
    Overrides:
    
    clearOneof in class GeneratedMessageV3.Builder<Value.Builder>
  - setRepeatedField
```
public Value.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                      int index,
                                      Object value)
```
    Description copied from interface: Message.Builder
    
    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 MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int) would return.
    
    Specified by:
    
    setRepeatedField in interface Message.Builder
    
    Overrides:
    
    setRepeatedField in class GeneratedMessageV3.Builder<Value.Builder>
  - addRepeatedField
```
public Value.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                      Object value)
```
    Description copied from interface: Message.Builder
    
    Like setRepeatedField, but appends the value as a new element.
    
    Specified by:
    
    addRepeatedField in interface Message.Builder
    
    Overrides:
    
    addRepeatedField in class GeneratedMessageV3.Builder<Value.Builder>
  - mergeFrom
```
public Value.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<Value.Builder>
  - mergeFrom
```
public Value.Builder mergeFrom(Value 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 GeneratedMessageV3.Builder<Value.Builder>
  - mergeFrom
```
public Value.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<Value.Builder>
    
    Throws:
    
    IOException
  - getKindCase
```
public Value.KindCase getKindCase()
```
    Specified by:
    
    getKindCase in interface ValueOrBuilder
  - clearKind
```
public Value.Builder clearKind()
```
  - getNullValueValue
```
public int getNullValueValue()
```
```
 Represents a null value.
 
```
    .google.protobuf.NullValue null_value = 1;
    Specified by:
    
    getNullValueValue in interface ValueOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for nullValue.
  - setNullValueValue
```
public Value.Builder setNullValueValue(int value)
```
```
 Represents a null value.
 
```
    .google.protobuf.NullValue null_value = 1;
    Parameters:
    
    value - The enum numeric value on the wire for nullValue to set.
    
    Returns:
    
    This builder for chaining.
  - getNullValue
```
public NullValue getNullValue()
```
```
 Represents a null value.
 
```
    .google.protobuf.NullValue null_value = 1;
    Specified by:
    
    getNullValue in interface ValueOrBuilder
    
    Returns:
    
    The nullValue.
  - setNullValue
```
public Value.Builder setNullValue(NullValue value)
```
```
 Represents a null value.
 
```
    .google.protobuf.NullValue null_value = 1;
    Parameters:
    
    value - The nullValue to set.
    
    Returns:
    
    This builder for chaining.
  - clearNullValue
```
public Value.Builder clearNullValue()
```
```
 Represents a null value.
 
```
    .google.protobuf.NullValue null_value = 1;
    Returns:
    
    This builder for chaining.
  - getNumberValue
```
public double getNumberValue()
```
```
 Represents a double value.
 
```
    double number_value = 2;
    Specified by:
    
    getNumberValue in interface ValueOrBuilder
    
    Returns:
    
    The numberValue.
  - setNumberValue
```
public Value.Builder setNumberValue(double value)
```
```
 Represents a double value.
 
```
    double number_value = 2;
    Parameters:
    
    value - The numberValue to set.
    
    Returns:
    
    This builder for chaining.
  - clearNumberValue
```
public Value.Builder clearNumberValue()
```
```
 Represents a double value.
 
```
    double number_value = 2;
    Returns:
    
    This builder for chaining.
  - getStringValue
```
public String getStringValue()
```
```
 Represents a string value.
 
```
    string string_value = 3;
    Specified by:
    
    getStringValue in interface ValueOrBuilder
    
    Returns:
    
    The stringValue.
  - getStringValueBytes
```
public ByteString getStringValueBytes()
```
```
 Represents a string value.
 
```
    string string_value = 3;
    Specified by:
    
    getStringValueBytes in interface ValueOrBuilder
    
    Returns:
    
    The bytes for stringValue.
  - setStringValue
```
public Value.Builder setStringValue(String value)
```
```
 Represents a string value.
 
```
    string string_value = 3;
    Parameters:
    
    value - The stringValue to set.
    
    Returns:
    
    This builder for chaining.
  - clearStringValue
```
public Value.Builder clearStringValue()
```
```
 Represents a string value.
 
```
    string string_value = 3;
    Returns:
    
    This builder for chaining.
  - setStringValueBytes
```
public Value.Builder setStringValueBytes(ByteString value)
```
```
 Represents a string value.
 
```
    string string_value = 3;
    Parameters:
    
    value - The bytes for stringValue to set.
    
    Returns:
    
    This builder for chaining.
  - getBoolValue
```
public boolean getBoolValue()
```
```
 Represents a boolean value.
 
```
    bool bool_value = 4;
    Specified by:
    
    getBoolValue in interface ValueOrBuilder
    
    Returns:
    
    The boolValue.
  - setBoolValue
```
public Value.Builder setBoolValue(boolean value)
```
```
 Represents a boolean value.
 
```
    bool bool_value = 4;
    Parameters:
    
    value - The boolValue to set.
    
    Returns:
    
    This builder for chaining.
  - clearBoolValue
```
public Value.Builder clearBoolValue()
```
```
 Represents a boolean value.
 
```
    bool bool_value = 4;
    Returns:
    
    This builder for chaining.
  - hasStructValue
```
public boolean hasStructValue()
```
```
 Represents a structured value.
 
```
    .google.protobuf.Struct struct_value = 5;
    Specified by:
    
    hasStructValue in interface ValueOrBuilder
    
    Returns:
    
    Whether the structValue field is set.
  - getStructValue
```
public Struct getStructValue()
```
```
 Represents a structured value.
 
```
    .google.protobuf.Struct struct_value = 5;
    Specified by:
    
    getStructValue in interface ValueOrBuilder
    
    Returns:
    
    The structValue.
  - setStructValue
```
public Value.Builder setStructValue(Struct value)
```
```
 Represents a structured value.
 
```
    .google.protobuf.Struct struct_value = 5;
  - setStructValue
```
public Value.Builder setStructValue(Struct.Builder builderForValue)
```
```
 Represents a structured value.
 
```
    .google.protobuf.Struct struct_value = 5;
  - mergeStructValue
```
public Value.Builder mergeStructValue(Struct value)
```
```
 Represents a structured value.
 
```
    .google.protobuf.Struct struct_value = 5;
  - clearStructValue
```
public Value.Builder clearStructValue()
```
```
 Represents a structured value.
 
```
    .google.protobuf.Struct struct_value = 5;
  - getStructValueBuilder
```
public Struct.Builder getStructValueBuilder()
```
```
 Represents a structured value.
 
```
    .google.protobuf.Struct struct_value = 5;
  - getStructValueOrBuilder
```
public StructOrBuilder getStructValueOrBuilder()
```
```
 Represents a structured value.
 
```
    .google.protobuf.Struct struct_value = 5;
    Specified by:
    
    getStructValueOrBuilder in interface ValueOrBuilder
  - hasListValue
```
public boolean hasListValue()
```
```
 Represents a repeated `Value`.
 
```
    .google.protobuf.ListValue list_value = 6;
    Specified by:
    
    hasListValue in interface ValueOrBuilder
    
    Returns:
    
    Whether the listValue field is set.
  - getListValue
```
public ListValue getListValue()
```
```
 Represents a repeated `Value`.
 
```
    .google.protobuf.ListValue list_value = 6;
    Specified by:
    
    getListValue in interface ValueOrBuilder
    
    Returns:
    
    The listValue.
  - setListValue
```
public Value.Builder setListValue(ListValue value)
```
```
 Represents a repeated `Value`.
 
```
    .google.protobuf.ListValue list_value = 6;
  - setListValue
```
public Value.Builder setListValue(ListValue.Builder builderForValue)
```
```
 Represents a repeated `Value`.
 
```
    .google.protobuf.ListValue list_value = 6;
  - mergeListValue
```
public Value.Builder mergeListValue(ListValue value)
```
```
 Represents a repeated `Value`.
 
```
    .google.protobuf.ListValue list_value = 6;
  - clearListValue
```
public Value.Builder clearListValue()
```
```
 Represents a repeated `Value`.
 
```
    .google.protobuf.ListValue list_value = 6;
  - getListValueBuilder
```
public ListValue.Builder getListValueBuilder()
```
```
 Represents a repeated `Value`.
 
```
    .google.protobuf.ListValue list_value = 6;
  - getListValueOrBuilder
```
public ListValueOrBuilder getListValueOrBuilder()
```
```
 Represents a repeated `Value`.
 
```
    .google.protobuf.ListValue list_value = 6;
    Specified by:
    
    getListValueOrBuilder in interface ValueOrBuilder
  - setUnknownFields
```
public final Value.Builder setUnknownFields(UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Set the UnknownFieldSet for this message.
    
    Specified by:
    
    setUnknownFields in interface Message.Builder
    
    Overrides:
    
    setUnknownFields in class GeneratedMessageV3.Builder<Value.Builder>
  - mergeUnknownFields
```
public final Value.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Merge some unknown fields into the UnknownFieldSet for this message.
    
    Specified by:
    
    mergeUnknownFields in interface Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class GeneratedMessageV3.Builder<Value.Builder>

Class Value.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getKindCase

clearKind

getNullValueValue

setNullValueValue

getNullValue

setNullValue

clearNullValue

getNumberValue

setNumberValue

clearNumberValue

getStringValue

getStringValueBytes

setStringValue

clearStringValue

setStringValueBytes

getBoolValue

setBoolValue

clearBoolValue

hasStructValue

getStructValue

setStructValue

setStructValue

mergeStructValue

clearStructValue

getStructValueBuilder

getStructValueOrBuilder

hasListValue

getListValue

setListValue

setListValue

mergeListValue

clearListValue

getListValueBuilder

getListValueOrBuilder

setUnknownFields

mergeUnknownFields