com.google.protobuf

Interface DescriptorProtos.MessageOptionsOrBuilder

All Superinterfaces:

GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.MessageOptions>, MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

DescriptorProtos.MessageOptions, DescriptorProtos.MessageOptions.Builder

Enclosing class:

DescriptorProtos

public static interface DescriptorProtos.MessageOptionsOrBuilder
extends GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.MessageOptions>

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getDeprecated() optional bool deprecated = 3 [default = false];
boolean	getMapEntry() optional bool map_entry = 7;
boolean	getMessageSetWireFormat() optional bool message_set_wire_format = 1 [default = false];
boolean	getNoStandardDescriptorAccessor() optional bool no_standard_descriptor_accessor = 2 [default = false];
DescriptorProtos.UninterpretedOption	getUninterpretedOption(int index) repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
int	getUninterpretedOptionCount() repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
List<DescriptorProtos.UninterpretedOption>	getUninterpretedOptionList() repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
DescriptorProtos.UninterpretedOptionOrBuilder	getUninterpretedOptionOrBuilder(int index) repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
List<? extends DescriptorProtos.UninterpretedOptionOrBuilder>	getUninterpretedOptionOrBuilderList() repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
boolean	hasDeprecated() optional bool deprecated = 3 [default = false];
boolean	hasMapEntry() optional bool map_entry = 7;
boolean	hasMessageSetWireFormat() optional bool message_set_wire_format = 1 [default = false];
boolean	hasNoStandardDescriptorAccessor() optional bool no_standard_descriptor_accessor = 2 [default = false];

Methods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder

getDefaultInstanceForType, getExtension, getExtension, getExtensionCount, hasExtension

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasMessageSetWireFormat

boolean hasMessageSetWireFormat()

optional bool message_set_wire_format = 1 [default = false];

 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.
 

getMessageSetWireFormat

boolean getMessageSetWireFormat()

optional bool message_set_wire_format = 1 [default = false];

 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.
 

hasNoStandardDescriptorAccessor

boolean hasNoStandardDescriptorAccessor()

optional bool no_standard_descriptor_accessor = 2 [default = false];

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

getNoStandardDescriptorAccessor

boolean getNoStandardDescriptorAccessor()

optional bool no_standard_descriptor_accessor = 2 [default = false];

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

hasDeprecated

boolean hasDeprecated()

optional bool deprecated = 3 [default = false];

 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.
 

getDeprecated

boolean getDeprecated()

optional bool deprecated = 3 [default = false];

 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.
 

hasMapEntry

boolean hasMapEntry()

optional bool map_entry = 7;

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

getMapEntry

boolean getMapEntry()

optional bool map_entry = 7;

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

getUninterpretedOptionList

List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

getUninterpretedOption

DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

getUninterpretedOptionCount

int getUninterpretedOptionCount()

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

getUninterpretedOptionOrBuilderList

List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> getUninterpretedOptionOrBuilderList()

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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

getUninterpretedOptionOrBuilder

DescriptorProtos.UninterpretedOptionOrBuilder getUninterpretedOptionOrBuilder(int index)

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

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