Package com.google.protobuf

Class DescriptorProtos.MessageOptions

    • Field Detail

      • MESSAGE_SET_WIRE_FORMAT_FIELD_NUMBER

        public static final int MESSAGE_SET_WIRE_FORMAT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NO_STANDARD_DESCRIPTOR_ACCESSOR_FIELD_NUMBER

        public static final int NO_STANDARD_DESCRIPTOR_ACCESSOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEPRECATED_FIELD_NUMBER

        public static final int DEPRECATED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEPRECATED_LEGACY_JSON_FIELD_CONFLICTS_FIELD_NUMBER

        public static final int DEPRECATED_LEGACY_JSON_FIELD_CONFLICTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UNINTERPRETED_OPTION_FIELD_NUMBER

        public static final int UNINTERPRETED_OPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • 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()
         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;
        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;
        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=578
         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 [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=578
         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 [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.

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DescriptorProtos.MessageOptions parseFrom​(java.nio.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​(java.io.InputStream input)
                                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

        public static DescriptorProtos.MessageOptions parseFrom​(com.google.protobuf.CodedInputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws java.io.IOException
        Throws:
        java.io.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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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