Package com.google.protobuf

Class DescriptorProtos.MessageOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.ExtendableMessage<DescriptorProtos.MessageOptions,DescriptorProtos.MessageOptions.Builder>
com.google.protobuf.DescriptorProtos.MessageOptions
All Implemented Interfaces:
DescriptorProtos.MessageOptionsOrBuilder, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<DescriptorProtos.MessageOptions,DescriptorProtos.MessageOptions.Builder>, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder
Enclosing class:
DescriptorProtos
public static final class DescriptorProtos.MessageOptions extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<DescriptorProtos.MessageOptions,DescriptorProtos.MessageOptions.Builder> implements DescriptorProtos.MessageOptionsOrBuilder
Protobuf type google.protobuf.MessageOptions

  • Field Details

    • MESSAGE_SET_WIRE_FORMAT_FIELD_NUMBER

      public static final int MESSAGE_SET_WIRE_FORMAT_FIELD_NUMBER
      See Also:

    • NO_STANDARD_DESCRIPTOR_ACCESSOR_FIELD_NUMBER

      public static final int NO_STANDARD_DESCRIPTOR_ACCESSOR_FIELD_NUMBER
      See Also:

    • DEPRECATED_FIELD_NUMBER

      public static final int DEPRECATED_FIELD_NUMBER
      See Also:

    • MAP_ENTRY_FIELD_NUMBER

      public static final int MAP_ENTRY_FIELD_NUMBER
      See Also:

    • DEPRECATED_LEGACY_JSON_FIELD_CONFLICTS_FIELD_NUMBER

      public static final int DEPRECATED_LEGACY_JSON_FIELD_CONFLICTS_FIELD_NUMBER
      See Also:

    • UNINTERPRETED_OPTION_FIELD_NUMBER

      public static final int UNINTERPRETED_OPTION_FIELD_NUMBER
      See Also:

  • Method Details

    • 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, json_name = "messageSetWireFormat"];
      Specified by:
      hasMessageSetWireFormat in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      Whether the messageSetWireFormat field is set.

    • 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, json_name = "messageSetWireFormat"];
      Specified by:
      getMessageSetWireFormat in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      The messageSetWireFormat.

    • 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, json_name = "noStandardDescriptorAccessor"];
      Specified by:
      hasNoStandardDescriptorAccessor in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      Whether the noStandardDescriptorAccessor field is set.

    • 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, json_name = "noStandardDescriptorAccessor"];
      Specified by:
      getNoStandardDescriptorAccessor in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      The noStandardDescriptorAccessor.

    • 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, json_name = "deprecated"];
      Specified by:
      hasDeprecated in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      Whether the deprecated field is set.

    • 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, json_name = "deprecated"];
      Specified by:
      getDeprecated in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      The deprecated.

    • hasMapEntry

      public boolean hasMapEntry()
       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.

 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.
      optional bool map_entry = 7 [json_name = "mapEntry"];
      Specified by:
      hasMapEntry in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      Whether the mapEntry field is set.

    • getMapEntry

      public boolean getMapEntry()
       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.

 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.
      optional bool map_entry = 7 [json_name = "mapEntry"];
      Specified by:
      getMapEntry in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      The mapEntry.

    • hasDeprecatedLegacyJsonFieldConflicts

      @Deprecated public boolean hasDeprecatedLegacyJsonFieldConflicts()
      Deprecated.
      google.protobuf.MessageOptions.deprecated_legacy_json_field_conflicts is deprecated. See google/protobuf/descriptor.proto;l=574
       Enable the legacy handling of JSON field name conflicts.  This lowercases
 and strips underscored from the fields before comparison in proto3 only.
 The new behavior takes `json_name` into account and applies to proto2 as
 well.

 This should only be used as a temporary measure against broken builds due
 to the change in behavior for JSON field name conflicts.

 TODO(b/261750190) This is legacy behavior we plan to remove once downstream
 teams have had time to migrate.
      optional bool deprecated_legacy_json_field_conflicts = 11 [json_name = "deprecatedLegacyJsonFieldConflicts", deprecated = true];
      Specified by:
      hasDeprecatedLegacyJsonFieldConflicts in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      Whether the deprecatedLegacyJsonFieldConflicts field is set.

    • getDeprecatedLegacyJsonFieldConflicts

      @Deprecated public boolean getDeprecatedLegacyJsonFieldConflicts()
      Deprecated.
      google.protobuf.MessageOptions.deprecated_legacy_json_field_conflicts is deprecated. See google/protobuf/descriptor.proto;l=574
       Enable the legacy handling of JSON field name conflicts.  This lowercases
 and strips underscored from the fields before comparison in proto3 only.
 The new behavior takes `json_name` into account and applies to proto2 as
 well.

 This should only be used as a temporary measure against broken builds due
 to the change in behavior for JSON field name conflicts.

 TODO(b/261750190) This is legacy behavior we plan to remove once downstream
 teams have had time to migrate.
      optional bool deprecated_legacy_json_field_conflicts = 11 [json_name = "deprecatedLegacyJsonFieldConflicts", deprecated = true];
      Specified by:
      getDeprecatedLegacyJsonFieldConflicts in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      The deprecatedLegacyJsonFieldConflicts.

    • getUninterpretedOptionList

      public List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999 [json_name = "uninterpretedOption"];
      Specified by:
      getUninterpretedOptionList in interface DescriptorProtos.MessageOptionsOrBuilder

    • 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 [json_name = "uninterpretedOption"];

    • getUninterpretedOptionCount

      public int getUninterpretedOptionCount()
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999 [json_name = "uninterpretedOption"];
      Specified by:
      getUninterpretedOptionCount in interface DescriptorProtos.MessageOptionsOrBuilder

    • getUninterpretedOption

      public DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999 [json_name = "uninterpretedOption"];
      Specified by:
      getUninterpretedOption in interface DescriptorProtos.MessageOptionsOrBuilder

    • getUninterpretedOptionOrBuilder

      public DescriptorProtos.UninterpretedOptionOrBuilder getUninterpretedOptionOrBuilder(int index)
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999 [json_name = "uninterpretedOption"];

    • parseFrom

      public static DescriptorProtos.MessageOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.MessageOptions parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.MessageOptions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.MessageOptions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.MessageOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.MessageOptions parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.MessageOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DescriptorProtos.MessageOptions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DescriptorProtos.MessageOptions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DescriptorProtos.MessageOptions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DescriptorProtos.MessageOptions parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DescriptorProtos.MessageOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static DescriptorProtos.MessageOptions.Builder newBuilder()

    • newBuilder

      public static DescriptorProtos.MessageOptions.Builder newBuilder(DescriptorProtos.MessageOptions prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<DescriptorProtos.MessageOptions,DescriptorProtos.MessageOptions.Builder>

    • getDefaultInstance

      public static DescriptorProtos.MessageOptions getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DescriptorProtos.MessageOptions> parser()