Class DescriptorProtos.MessageOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<DescriptorProtos.MessageOptions>
com.google.protobuf.generated.DescriptorProtos.MessageOptions
All Implemented Interfaces:
DescriptorProtos.MessageOptionsOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.MessageOptions>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
DescriptorProtos
public static final class DescriptorProtos.MessageOptions extends com.google.protobuf.GeneratedMessage.ExtendableMessage<DescriptorProtos.MessageOptions> implements DescriptorProtos.MessageOptionsOrBuilder
Protobuf type google.protobuf.MessageOptions
See Also:

  • 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:

    • FEATURES_FIELD_NUMBER

      public static final int FEATURES_FIELD_NUMBER
      See Also:

    • UNINTERPRETED_OPTION_FIELD_NUMBER

      public static final int UNINTERPRETED_OPTION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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

    • 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;
      Specified by:
      hasMapEntry in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      Whether the mapEntry field is set.

    • 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;
      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=631
       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 This is legacy behavior we plan to remove once downstream
 teams have had time to migrate.
      optional bool deprecated_legacy_json_field_conflicts = 11 [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=631
       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 This is legacy behavior we plan to remove once downstream
 teams have had time to migrate.
      optional bool deprecated_legacy_json_field_conflicts = 11 [deprecated = true];
      Specified by:
      getDeprecatedLegacyJsonFieldConflicts in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      The deprecatedLegacyJsonFieldConflicts.

    • hasFeatures

      public boolean hasFeatures()
       Any features defined in the specific edition.
      optional .google.protobuf.FeatureSet features = 12;
      Specified by:
      hasFeatures in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      Whether the features field is set.

    • getFeatures

      public DescriptorProtos.FeatureSet getFeatures()
       Any features defined in the specific edition.
      optional .google.protobuf.FeatureSet features = 12;
      Specified by:
      getFeatures in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      The features.

    • getFeaturesOrBuilder

      public DescriptorProtos.FeatureSetOrBuilder getFeaturesOrBuilder()
       Any features defined in the specific edition.
      optional .google.protobuf.FeatureSet features = 12;
      Specified by:
      getFeaturesOrBuilder in interface DescriptorProtos.MessageOptionsOrBuilder

    • getUninterpretedOptionList

      public List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
      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;
      Specified by:
      getUninterpretedOptionOrBuilderList in interface DescriptorProtos.MessageOptionsOrBuilder

    • getUninterpretedOptionCount

      public int getUninterpretedOptionCount()
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
      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;
      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;
      Specified by:
      getUninterpretedOptionOrBuilder in interface DescriptorProtos.MessageOptionsOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<DescriptorProtos.MessageOptions>

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • 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

    • newBuilderForType

      public DescriptorProtos.MessageOptions.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DescriptorProtos.MessageOptions.Builder newBuilder()

    • newBuilder

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

    • toBuilder

      public DescriptorProtos.MessageOptions.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DescriptorProtos.MessageOptions.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DescriptorProtos.MessageOptions getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DescriptorProtos.MessageOptions> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public DescriptorProtos.MessageOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.MessageOptions>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder