Class DescriptorProtos.MessageOptions

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

  • Field Details

    • bitField0_

      private int bitField0_

    • MESSAGE_SET_WIRE_FORMAT_FIELD_NUMBER

      public static final int MESSAGE_SET_WIRE_FORMAT_FIELD_NUMBER
      See Also:

    • messageSetWireFormat_

      private boolean messageSetWireFormat_

    • NO_STANDARD_DESCRIPTOR_ACCESSOR_FIELD_NUMBER

      public static final int NO_STANDARD_DESCRIPTOR_ACCESSOR_FIELD_NUMBER
      See Also:

    • noStandardDescriptorAccessor_

      private boolean noStandardDescriptorAccessor_

    • DEPRECATED_FIELD_NUMBER

      public static final int DEPRECATED_FIELD_NUMBER
      See Also:

    • deprecated_

      private boolean deprecated_

    • MAP_ENTRY_FIELD_NUMBER

      public static final int MAP_ENTRY_FIELD_NUMBER
      See Also:

    • mapEntry_

      private boolean mapEntry_

    • DEPRECATED_LEGACY_JSON_FIELD_CONFLICTS_FIELD_NUMBER

      public static final int DEPRECATED_LEGACY_JSON_FIELD_CONFLICTS_FIELD_NUMBER
      See Also:

    • deprecatedLegacyJsonFieldConflicts_

      private boolean deprecatedLegacyJsonFieldConflicts_

    • FEATURES_FIELD_NUMBER

      public static final int FEATURES_FIELD_NUMBER
      See Also:

    • features_

      private DescriptorProtos.FeatureSet features_

    • UNINTERPRETED_OPTION_FIELD_NUMBER

      public static final int UNINTERPRETED_OPTION_FIELD_NUMBER
      See Also:

    • uninterpretedOption_

      private Internal.ProtobufList<DescriptorProtos.UninterpretedOption> uninterpretedOption_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final DescriptorProtos.MessageOptions DEFAULT_INSTANCE

    • PARSER

      private static volatile Parser<DescriptorProtos.MessageOptions> PARSER

  • Constructor Details

    • MessageOptions

      private MessageOptions()

  • 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];
      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.

    • setMessageSetWireFormat

      private void 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];
      Parameters:
      value - The messageSetWireFormat to set.

    • clearMessageSetWireFormat

      private void 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];

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

    • setNoStandardDescriptorAccessor

      private void 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];
      Parameters:
      value - The noStandardDescriptorAccessor to set.

    • clearNoStandardDescriptorAccessor

      private void 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];

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

    • setDeprecated

      private void 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];
      Parameters:
      value - The deprecated to set.

    • clearDeprecated

      private void 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];

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

    • setMapEntry

      private void 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;
      Parameters:
      value - The mapEntry to set.

    • clearMapEntry

      private void 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;

    • hasDeprecatedLegacyJsonFieldConflicts

      @Deprecated public boolean hasDeprecatedLegacyJsonFieldConflicts()
      Deprecated.
      google.protobuf.MessageOptions.deprecated_legacy_json_field_conflicts is deprecated. See google/protobuf/descriptor.proto;l=656
      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=656
      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.

    • setDeprecatedLegacyJsonFieldConflicts

      private void setDeprecatedLegacyJsonFieldConflicts(boolean value)
      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];
      Parameters:
      value - The deprecatedLegacyJsonFieldConflicts to set.

    • clearDeprecatedLegacyJsonFieldConflicts

      private void clearDeprecatedLegacyJsonFieldConflicts()
      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];

    • hasFeatures

      public boolean hasFeatures()
      Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special
cases like the proto compiler. Other uses are discouraged and
developers should rely on the protoreflect APIs for their client language.
      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.
WARNING: This field should only be used by protobuf plugins or special
cases like the proto compiler. Other uses are discouraged and
developers should rely on the protoreflect APIs for their client language.
      optional .google.protobuf.FeatureSet features = 12;
      Specified by:
      getFeatures in interface DescriptorProtos.MessageOptionsOrBuilder
      Returns:
      The features.

    • setFeatures

      private void setFeatures(DescriptorProtos.FeatureSet value)
      Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special
cases like the proto compiler. Other uses are discouraged and
developers should rely on the protoreflect APIs for their client language.
      optional .google.protobuf.FeatureSet features = 12;

    • mergeFeatures

      private void mergeFeatures(DescriptorProtos.FeatureSet value)
      Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special
cases like the proto compiler. Other uses are discouraged and
developers should rely on the protoreflect APIs for their client language.
      optional .google.protobuf.FeatureSet features = 12;

    • clearFeatures

      private void clearFeatures()
      Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special
cases like the proto compiler. Other uses are discouraged and
developers should rely on the protoreflect APIs for their client language.
      optional .google.protobuf.FeatureSet features = 12;

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

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

    • ensureUninterpretedOptionIsMutable

      private void ensureUninterpretedOptionIsMutable()

    • setUninterpretedOption

      private void setUninterpretedOption(int index, DescriptorProtos.UninterpretedOption value)
      The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    • addUninterpretedOption

      private void addUninterpretedOption(DescriptorProtos.UninterpretedOption value)
      The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    • addUninterpretedOption

      private void addUninterpretedOption(int index, DescriptorProtos.UninterpretedOption value)
      The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    • addAllUninterpretedOption

      private void addAllUninterpretedOption(Iterable<? extends DescriptorProtos.UninterpretedOption> values)
      The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    • clearUninterpretedOption

      private void clearUninterpretedOption()
      The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    • removeUninterpretedOption

      private void removeUninterpretedOption(int index)
      The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static DescriptorProtos.MessageOptions parseFrom(InputStream input, 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, ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseFrom

      public static DescriptorProtos.MessageOptions parseFrom(CodedInputStream input, 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(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Description copied from class: GeneratedMessageLite
      A method that implements different types of operations described in GeneratedMessageLite.MethodToInvoke. These different kinds of operations are required to implement message-level operations for builders in the runtime. This method bundles those operations to reduce the generated methods count.
      • NEW_INSTANCE returns a new instance of the protocol buffer that has not yet been made immutable. See MAKE_IMMUTABLE.
      • IS_INITIALIZED returns null for false and the default instance for true. It doesn't use or modify any memoized value.
      • GET_MEMOIZED_IS_INITIALIZED returns the memoized isInitialized byte value.
      • SET_MEMOIZED_IS_INITIALIZED sets the memoized isInitialized byte value to 1 if the first parameter is not null, or to 0 if the first parameter is null.
      • NEW_BUILDER returns a BuilderType instance.
      This method, plus the implementation of the Builder, enables the Builder class to be proguarded away entirely on Android.

      For use by generated code only.

      Specified by:
      dynamicMethod in class GeneratedMessageLite<DescriptorProtos.MessageOptions, DescriptorProtos.MessageOptions.Builder>

    • getDefaultInstance

      public static DescriptorProtos.MessageOptions getDefaultInstance()

    • parser

      public static Parser<DescriptorProtos.MessageOptions> parser()