Class DescriptorProtos.MessageOptions.Builder (3.19.4)

public static final class DescriptorProtos.MessageOptions.Builder extends GeneratedMessageV3.ExtendableBuilder<DescriptorProtos.MessageOptions,DescriptorProtos.MessageOptions.Builder> implements DescriptorProtos.MessageOptionsOrBuilder

Protobuf type google.protobuf.MessageOptions

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder<BuilderType> > GeneratedMessageV3.ExtendableBuilder > DescriptorProtos.MessageOptions.Builder

Implements

DescriptorProtos.MessageOptionsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

GeneratedMessageV3.ExtendableBuilder.<Type>addExtension(Extension<MessageType,List<Type>>,Type)

GeneratedMessageV3.ExtendableBuilder.<Type>addExtension(ExtensionLite<MessageType,List<Type>>,Type)

GeneratedMessageV3.ExtendableBuilder.<Type>addExtension(GeneratedMessage.GeneratedExtension<MessageType,List<Type>>,Type)

GeneratedMessageV3.ExtendableBuilder.<Type>clearExtension(Extension<MessageType,?>)

GeneratedMessageV3.ExtendableBuilder.<Type>clearExtension(GeneratedMessage.GeneratedExtension<MessageType,?>)

GeneratedMessageV3.ExtendableBuilder.<Type>getExtension(Extension<MessageType,Type>)

GeneratedMessageV3.ExtendableBuilder.<Type>getExtension(Extension<MessageType,List<Type>>,int)

GeneratedMessageV3.ExtendableBuilder.<Type>getExtension(ExtensionLite<MessageType,Type>)

GeneratedMessageV3.ExtendableBuilder.<Type>getExtension(ExtensionLite<MessageType,List<Type>>,int)

GeneratedMessageV3.ExtendableBuilder.<Type>getExtension(GeneratedMessage.GeneratedExtension<MessageType,Type>)

GeneratedMessageV3.ExtendableBuilder.<Type>getExtension(GeneratedMessage.GeneratedExtension<MessageType,List<Type>>,int)

GeneratedMessageV3.ExtendableBuilder.<Type>getExtensionCount(Extension<MessageType,List<Type>>)

GeneratedMessageV3.ExtendableBuilder.<Type>getExtensionCount(ExtensionLite<MessageType,List<Type>>)

GeneratedMessageV3.ExtendableBuilder.<Type>getExtensionCount(GeneratedMessage.GeneratedExtension<MessageType,List<Type>>)

GeneratedMessageV3.ExtendableBuilder.<Type>hasExtension(Extension<MessageType,Type>)

GeneratedMessageV3.ExtendableBuilder.<Type>hasExtension(ExtensionLite<MessageType,Type>)

GeneratedMessageV3.ExtendableBuilder.<Type>hasExtension(GeneratedMessage.GeneratedExtension<MessageType,Type>)

GeneratedMessageV3.ExtendableBuilder.<Type>setExtension(Extension<MessageType,Type>,Type)

GeneratedMessageV3.ExtendableBuilder.<Type>setExtension(Extension<MessageType,List<Type>>,int,Type)

GeneratedMessageV3.ExtendableBuilder.<Type>setExtension(ExtensionLite<MessageType,Type>,Type)

GeneratedMessageV3.ExtendableBuilder.<Type>setExtension(ExtensionLite<MessageType,List<Type>>,int,Type)

GeneratedMessageV3.ExtendableBuilder.<Type>setExtension(GeneratedMessage.GeneratedExtension<MessageType,Type>,Type)

GeneratedMessageV3.ExtendableBuilder.<Type>setExtension(GeneratedMessage.GeneratedExtension<MessageType,List<Type>>,int,Type)

GeneratedMessageV3.ExtendableBuilder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.ExtendableBuilder.clear()

GeneratedMessageV3.ExtendableBuilder.clearExtension(ExtensionLite<MessageType,?>)

GeneratedMessageV3.ExtendableBuilder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.ExtendableBuilder.extensionsAreInitialized()

GeneratedMessageV3.ExtendableBuilder.getAllFields()

GeneratedMessageV3.ExtendableBuilder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.ExtendableBuilder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.ExtendableBuilder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.ExtendableBuilder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.ExtendableBuilder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.ExtendableBuilder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.ExtendableBuilder.isInitialized()

GeneratedMessageV3.ExtendableBuilder.mergeExtensionFields(GeneratedMessageV3.ExtendableMessage)

GeneratedMessageV3.ExtendableBuilder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.ExtendableBuilder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.ExtendableBuilder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptors.Descriptor

Methods

<Type>addExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.MessageOptions,List<Type>> extension, Type value)

public DescriptorProtos.MessageOptions.Builder <Type>addExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.MessageOptions,List<Type>> extension, Type value)

Append a value to a repeated extension.

Parameters
Name	Description
extension	GeneratedExtension<MessageOptions,List<Type>>
value	Type

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>.<Type>addExtension(GeneratedMessage.GeneratedExtension<MessageType,List<Type>> extension, Type value)

<Type>clearExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.MessageOptions,?> extension)

public DescriptorProtos.MessageOptions.Builder <Type>clearExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.MessageOptions,?> extension)

Clear an extension.

Parameter
Name	Description
extension	GeneratedExtension<MessageOptions,?>

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>.<Type>clearExtension(GeneratedMessage.GeneratedExtension<MessageType,?> extension)

<Type>setExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.MessageOptions,Type> extension, Type value)

public DescriptorProtos.MessageOptions.Builder <Type>setExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.MessageOptions,Type> extension, Type value)

Set the value of an extension.

Parameters
Name	Description
extension	GeneratedExtension<MessageOptions,Type>
value	Type

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>.<Type>setExtension(GeneratedMessage.GeneratedExtension<MessageType,Type> extension, Type value)

<Type>setExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.MessageOptions,List<Type>> extension, int index, Type value)

public DescriptorProtos.MessageOptions.Builder <Type>setExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.MessageOptions,List<Type>> extension, int index, Type value)

Set the value of one element of a repeated extension.

Parameters
Name	Description
extension	GeneratedExtension<MessageOptions,List<Type>>
index	int
value	Type

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>.<Type>setExtension(GeneratedMessage.GeneratedExtension<MessageType,List<Type>> extension, int index, Type value)

addAllUninterpretedOption(Iterable<? extends DescriptorProtos.UninterpretedOption> values)

public DescriptorProtos.MessageOptions.Builder addAllUninterpretedOption(Iterable<? extends DescriptorProtos.UninterpretedOption> values)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
Name	Description
values	Iterable<? extends com.google.protobuf.DescriptorProtos.UninterpretedOption>

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DescriptorProtos.MessageOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	Descriptors.FieldDescriptor
value	Object

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addUninterpretedOption(DescriptorProtos.UninterpretedOption value)

public DescriptorProtos.MessageOptions.Builder addUninterpretedOption(DescriptorProtos.UninterpretedOption value)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
Name	Description
value	DescriptorProtos.UninterpretedOption

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

addUninterpretedOption(DescriptorProtos.UninterpretedOption.Builder builderForValue)

public DescriptorProtos.MessageOptions.Builder addUninterpretedOption(DescriptorProtos.UninterpretedOption.Builder builderForValue)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
Name	Description
builderForValue	DescriptorProtos.UninterpretedOption.Builder

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

addUninterpretedOption(int index, DescriptorProtos.UninterpretedOption value)

public DescriptorProtos.MessageOptions.Builder addUninterpretedOption(int index, DescriptorProtos.UninterpretedOption value)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameters
Name	Description
index	int
value	DescriptorProtos.UninterpretedOption

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

addUninterpretedOption(int index, DescriptorProtos.UninterpretedOption.Builder builderForValue)

public DescriptorProtos.MessageOptions.Builder addUninterpretedOption(int index, DescriptorProtos.UninterpretedOption.Builder builderForValue)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameters
Name	Description
index	int
builderForValue	DescriptorProtos.UninterpretedOption.Builder

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

addUninterpretedOptionBuilder()

public DescriptorProtos.UninterpretedOption.Builder addUninterpretedOptionBuilder()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
Type	Description
DescriptorProtos.UninterpretedOption.Builder

addUninterpretedOptionBuilder(int index)

public DescriptorProtos.UninterpretedOption.Builder addUninterpretedOptionBuilder(int index)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
Name	Description
index	int

Returns
Type	Description
DescriptorProtos.UninterpretedOption.Builder

build()

public DescriptorProtos.MessageOptions build()

Returns
Type	Description
DescriptorProtos.MessageOptions

buildPartial()

public DescriptorProtos.MessageOptions buildPartial()

Returns
Type	Description
DescriptorProtos.MessageOptions

clear()

public DescriptorProtos.MessageOptions.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.

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>.clear()

clearDeprecated()

public DescriptorProtos.MessageOptions.Builder clearDeprecated()

Is this message deprecated? Depending on the target platform, this can emit Deprecated annotations for the message, or it will be completely ignored; in the very least, this is a formalization for deprecating messages.

optional bool deprecated = 3 [default = false];

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DescriptorProtos.MessageOptions.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	Descriptors.FieldDescriptor

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearMapEntry()

public DescriptorProtos.MessageOptions.Builder clearMapEntry()

Whether the message is an automatically generated map entry type for the maps field. For maps fields: map<KeyType, ValueType> map_field = 1; The parsed descriptor looks like: message MapFieldEntry { option map_entry = true; optional KeyType key = 1; optional ValueType value = 2; } repeated MapFieldEntry map_field = 1; Implementations may choose not to generate the map_entry=true message, but use a native map in the target language to hold the keys and values. The reflection APIs in such implementations still need to work as if the field is a repeated message field. NOTE: Do not set the option in .proto files. Always use the maps syntax instead. The option should only be implicitly set by the proto compiler parser.

optional bool map_entry = 7;

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder	This builder for chaining.

clearMessageSetWireFormat()

public DescriptorProtos.MessageOptions.Builder clearMessageSetWireFormat()

Set true to use the old proto1 MessageSet wire format for extensions. This is provided for backwards-compatibility with the MessageSet wire format. You should not use this for any other reason: It's less efficient, has fewer features, and is more complicated. The message must be defined exactly as follows: message Foo { option message_set_wire_format = true; extensions 4 to max; } Note that the message cannot have any defined fields; MessageSets only have extensions. All extensions of your type must be singular messages; e.g. they cannot be int32s, enums, or repeated messages. Because this is an option, the above two restrictions are not enforced by the protocol compiler.

optional bool message_set_wire_format = 1 [default = false];

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder	This builder for chaining.

clearNoStandardDescriptorAccessor()

public DescriptorProtos.MessageOptions.Builder clearNoStandardDescriptorAccessor()

Disables the generation of the standard "descriptor()" accessor, which can conflict with a field of the same name. This is meant to make migration from proto1 easier; new code should avoid fields named "descriptor".

optional bool no_standard_descriptor_accessor = 2 [default = false];

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DescriptorProtos.MessageOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)

TODO(jieluo): Clear it when all subclasses have implemented this method.

Parameter
Name	Description
oneof	Descriptors.OneofDescriptor

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearUninterpretedOption()

public DescriptorProtos.MessageOptions.Builder clearUninterpretedOption()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

clone()

public DescriptorProtos.MessageOptions.Builder clone()

Clones the Builder.

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public DescriptorProtos.MessageOptions getDefaultInstanceForType()

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.

Returns
Type	Description
DescriptorProtos.MessageOptions

getDeprecated()

public boolean getDeprecated()

Is this message deprecated? Depending on the target platform, this can emit Deprecated annotations for the message, or it will be completely ignored; in the very least, this is a formalization for deprecating messages.

optional bool deprecated = 3 [default = false];

Returns
Type	Description
boolean	The deprecated.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Get the message's type's descriptor. This differs from the getDescriptor() method of generated message classes in that this method is an abstract method of the Message interface whereas getDescriptor() is a static method of a specific class. They return the same thing.

Returns
Type	Description
Descriptors.Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMapEntry()

public boolean getMapEntry()

Whether the message is an automatically generated map entry type for the maps field. For maps fields: map<KeyType, ValueType> map_field = 1; The parsed descriptor looks like: message MapFieldEntry { option map_entry = true; optional KeyType key = 1; optional ValueType value = 2; } repeated MapFieldEntry map_field = 1; Implementations may choose not to generate the map_entry=true message, but use a native map in the target language to hold the keys and values. The reflection APIs in such implementations still need to work as if the field is a repeated message field. NOTE: Do not set the option in .proto files. Always use the maps syntax instead. The option should only be implicitly set by the proto compiler parser.

optional bool map_entry = 7;

Returns
Type	Description
boolean	The mapEntry.

getMessageSetWireFormat()

public boolean getMessageSetWireFormat()

Set true to use the old proto1 MessageSet wire format for extensions. This is provided for backwards-compatibility with the MessageSet wire format. You should not use this for any other reason: It's less efficient, has fewer features, and is more complicated. The message must be defined exactly as follows: message Foo { option message_set_wire_format = true; extensions 4 to max; } Note that the message cannot have any defined fields; MessageSets only have extensions. All extensions of your type must be singular messages; e.g. they cannot be int32s, enums, or repeated messages. Because this is an option, the above two restrictions are not enforced by the protocol compiler.

optional bool message_set_wire_format = 1 [default = false];

Returns
Type	Description
boolean	The messageSetWireFormat.

getNoStandardDescriptorAccessor()

public boolean getNoStandardDescriptorAccessor()

Disables the generation of the standard "descriptor()" accessor, which can conflict with a field of the same name. This is meant to make migration from proto1 easier; new code should avoid fields named "descriptor".

optional bool no_standard_descriptor_accessor = 2 [default = false];

Returns
Type	Description
boolean	The noStandardDescriptorAccessor.

getUninterpretedOption(int index)

public DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
Name	Description
index	int

Returns
Type	Description
DescriptorProtos.UninterpretedOption

getUninterpretedOptionBuilder(int index)

public DescriptorProtos.UninterpretedOption.Builder getUninterpretedOptionBuilder(int index)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
Name	Description
index	int

Returns
Type	Description
DescriptorProtos.UninterpretedOption.Builder

getUninterpretedOptionBuilderList()

public List<DescriptorProtos.UninterpretedOption.Builder> getUninterpretedOptionBuilderList()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
Type	Description
List<Builder>

getUninterpretedOptionCount()

public int getUninterpretedOptionCount()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
Type	Description
int

getUninterpretedOptionList()

public List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
Type	Description
List<UninterpretedOption>

getUninterpretedOptionOrBuilder(int index)

public DescriptorProtos.UninterpretedOptionOrBuilder getUninterpretedOptionOrBuilder(int index)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
Name	Description
index	int

Returns
Type	Description
DescriptorProtos.UninterpretedOptionOrBuilder

getUninterpretedOptionOrBuilderList()

public List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> getUninterpretedOptionOrBuilderList()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
Type	Description
List<? extends com.google.protobuf.DescriptorProtos.UninterpretedOptionOrBuilder>

hasDeprecated()

public boolean hasDeprecated()

Is this message deprecated? Depending on the target platform, this can emit Deprecated annotations for the message, or it will be completely ignored; in the very least, this is a formalization for deprecating messages.

optional bool deprecated = 3 [default = false];

Returns
Type	Description
boolean	Whether the deprecated field is set.

hasMapEntry()

public boolean hasMapEntry()

Whether the message is an automatically generated map entry type for the maps field. For maps fields: map<KeyType, ValueType> map_field = 1; The parsed descriptor looks like: message MapFieldEntry { option map_entry = true; optional KeyType key = 1; optional ValueType value = 2; } repeated MapFieldEntry map_field = 1; Implementations may choose not to generate the map_entry=true message, but use a native map in the target language to hold the keys and values. The reflection APIs in such implementations still need to work as if the field is a repeated message field. NOTE: Do not set the option in .proto files. Always use the maps syntax instead. The option should only be implicitly set by the proto compiler parser.

optional bool map_entry = 7;

Returns
Type	Description
boolean	Whether the mapEntry field is set.

hasMessageSetWireFormat()

public boolean hasMessageSetWireFormat()

Set true to use the old proto1 MessageSet wire format for extensions. This is provided for backwards-compatibility with the MessageSet wire format. You should not use this for any other reason: It's less efficient, has fewer features, and is more complicated. The message must be defined exactly as follows: message Foo { option message_set_wire_format = true; extensions 4 to max; } Note that the message cannot have any defined fields; MessageSets only have extensions. All extensions of your type must be singular messages; e.g. they cannot be int32s, enums, or repeated messages. Because this is an option, the above two restrictions are not enforced by the protocol compiler.

optional bool message_set_wire_format = 1 [default = false];

Returns
Type	Description
boolean	Whether the messageSetWireFormat field is set.

hasNoStandardDescriptorAccessor()

public boolean hasNoStandardDescriptorAccessor()

Disables the generation of the standard "descriptor()" accessor, which can conflict with a field of the same name. This is meant to make migration from proto1 easier; new code should avoid fields named "descriptor".

optional bool no_standard_descriptor_accessor = 2 [default = false];

Returns
Type	Description
boolean	Whether the noStandardDescriptorAccessor field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

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.

Returns
Type	Description
GeneratedMessageV3.FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

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

See also: MessageOrBuilder#getInitializationErrorString()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DescriptorProtos.MessageOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(DescriptorProtos.MessageOptions other)

public DescriptorProtos.MessageOptions.Builder mergeFrom(DescriptorProtos.MessageOptions other)

Parameter
Name	Description
other	DescriptorProtos.MessageOptions

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

mergeFrom(Message other)

public DescriptorProtos.MessageOptions.Builder mergeFrom(Message other)

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

Parameter
Name	Description
other	Message

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DescriptorProtos.MessageOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Merge some unknown fields into the UnknownFieldSet for this message.

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeUninterpretedOption(int index)

public DescriptorProtos.MessageOptions.Builder removeUninterpretedOption(int index)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
Name	Description
index	int

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

setDeprecated(boolean value)

public DescriptorProtos.MessageOptions.Builder setDeprecated(boolean value)

Is this message deprecated? Depending on the target platform, this can emit Deprecated annotations for the message, or it will be completely ignored; in the very least, this is a formalization for deprecating messages.

optional bool deprecated = 3 [default = false];

Parameter
Name	Description
value	boolean The deprecated to set.

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DescriptorProtos.MessageOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	Descriptors.FieldDescriptor
value	Object

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMapEntry(boolean value)

public DescriptorProtos.MessageOptions.Builder setMapEntry(boolean value)

Whether the message is an automatically generated map entry type for the maps field. For maps fields: map<KeyType, ValueType> map_field = 1; The parsed descriptor looks like: message MapFieldEntry { option map_entry = true; optional KeyType key = 1; optional ValueType value = 2; } repeated MapFieldEntry map_field = 1; Implementations may choose not to generate the map_entry=true message, but use a native map in the target language to hold the keys and values. The reflection APIs in such implementations still need to work as if the field is a repeated message field. NOTE: Do not set the option in .proto files. Always use the maps syntax instead. The option should only be implicitly set by the proto compiler parser.

optional bool map_entry = 7;

Parameter
Name	Description
value	boolean The mapEntry to set.

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder	This builder for chaining.

setMessageSetWireFormat(boolean value)

public DescriptorProtos.MessageOptions.Builder setMessageSetWireFormat(boolean value)

Set true to use the old proto1 MessageSet wire format for extensions. This is provided for backwards-compatibility with the MessageSet wire format. You should not use this for any other reason: It's less efficient, has fewer features, and is more complicated. The message must be defined exactly as follows: message Foo { option message_set_wire_format = true; extensions 4 to max; } Note that the message cannot have any defined fields; MessageSets only have extensions. All extensions of your type must be singular messages; e.g. they cannot be int32s, enums, or repeated messages. Because this is an option, the above two restrictions are not enforced by the protocol compiler.

optional bool message_set_wire_format = 1 [default = false];

Parameter
Name	Description
value	boolean The messageSetWireFormat to set.

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder	This builder for chaining.

setNoStandardDescriptorAccessor(boolean value)

public DescriptorProtos.MessageOptions.Builder setNoStandardDescriptorAccessor(boolean value)

Disables the generation of the standard "descriptor()" accessor, which can conflict with a field of the same name. This is meant to make migration from proto1 easier; new code should avoid fields named "descriptor".

optional bool no_standard_descriptor_accessor = 2 [default = false];

Parameter
Name	Description
value	boolean The noStandardDescriptorAccessor to set.

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DescriptorProtos.MessageOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	Descriptors.FieldDescriptor
index	int
value	Object

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUninterpretedOption(int index, DescriptorProtos.UninterpretedOption value)

public DescriptorProtos.MessageOptions.Builder setUninterpretedOption(int index, DescriptorProtos.UninterpretedOption value)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameters
Name	Description
index	int
value	DescriptorProtos.UninterpretedOption

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

setUninterpretedOption(int index, DescriptorProtos.UninterpretedOption.Builder builderForValue)

public DescriptorProtos.MessageOptions.Builder setUninterpretedOption(int index, DescriptorProtos.UninterpretedOption.Builder builderForValue)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameters
Name	Description
index	int
builderForValue	DescriptorProtos.UninterpretedOption.Builder

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final DescriptorProtos.MessageOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
DescriptorProtos.MessageOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)