public static final class DescriptorProtos.MessageOptions extends GeneratedMessageV3.ExtendableMessage<DescriptorProtos.MessageOptions> implements DescriptorProtos.MessageOptionsOrBuilder
Protobuf type google.protobuf.MessageOptions
Static Fields
DEPRECATED_FIELD_NUMBER
public static final int DEPRECATED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAP_ENTRY_FIELD_NUMBER
public static final int MAP_ENTRY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MESSAGE_SET_WIRE_FORMAT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NO_STANDARD_DESCRIPTOR_ACCESSOR_FIELD_NUMBER
public static final int NO_STANDARD_DESCRIPTOR_ACCESSOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARSER
public static final Parser<DescriptorProtos.MessageOptions> PARSER
UNINTERPRETED_OPTION_FIELD_NUMBER
public static final int UNINTERPRETED_OPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static DescriptorProtos.MessageOptions getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DescriptorProtos.MessageOptions.Builder newBuilder()
newBuilder(DescriptorProtos.MessageOptions prototype)
public static DescriptorProtos.MessageOptions.Builder newBuilder(DescriptorProtos.MessageOptions prototype)
public static DescriptorProtos.MessageOptions parseDelimitedFrom(InputStream input)
public static DescriptorProtos.MessageOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DescriptorProtos.MessageOptions parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.MessageOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DescriptorProtos.MessageOptions parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.MessageOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.MessageOptions parseFrom(CodedInputStream input)
public static DescriptorProtos.MessageOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.MessageOptions parseFrom(InputStream input)
public static DescriptorProtos.MessageOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DescriptorProtos.MessageOptions parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DescriptorProtos.MessageOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DescriptorProtos.MessageOptions> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Compares the specified object with this message for equality. Returns true if the given
object is a message of the same type (as defined by getDescriptorForType()) and has
identical values for all of its fields. Subclasses must implement this; inheriting
Object.equals() is incorrect.
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public DescriptorProtos.MessageOptions getDefaultInstanceForType()
Get an instance of the type with no fields set. Because no fields are set, all getters for
singular fields will return default values and repeated fields will appear empty. This may or
may not be a singleton. This differs from the getDefaultInstance() method of generated
message classes in that this method is an abstract method of the MessageLite interface
whereas getDefaultInstance() is a static method of a specific class. They return the
same thing.
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];
| Returns |
| Type |
Description |
boolean |
The deprecated.
|
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;
| Returns |
| Type |
Description |
boolean |
The mapEntry.
|
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];
| Returns |
| Type |
Description |
boolean |
The messageSetWireFormat.
|
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];
| Returns |
| Type |
Description |
boolean |
The noStandardDescriptorAccessor.
|
getParserForType()
public Parser<DescriptorProtos.MessageOptions> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Get the number of bytes required to encode this message. The result is only computed on the
first call and memoized after that.
If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will
be smaller than the actual number of bytes required and might be negative.
| Returns |
| Type |
Description |
int |
|
Overrides
getUninterpretedOption(int index)
public DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
| Parameter |
| Name |
Description |
index |
int
|
getUninterpretedOptionCount()
public int getUninterpretedOptionCount()
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
| Returns |
| Type |
Description |
int |
|
getUninterpretedOptionList()
public List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
getUninterpretedOptionOrBuilder(int index)
public DescriptorProtos.UninterpretedOptionOrBuilder getUninterpretedOptionOrBuilder(int index)
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
| Parameter |
| Name |
Description |
index |
int
|
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;
| Returns |
| Type |
Description |
List<? extends com.google.protobuf.DescriptorProtos.UninterpretedOptionOrBuilder> |
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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];
| Returns |
| Type |
Description |
boolean |
Whether the deprecated field is set.
|
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;
| Returns |
| Type |
Description |
boolean |
Whether the mapEntry field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the messageSetWireFormat field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the noStandardDescriptorAccessor field is set.
|
hashCode()
Returns the hash code value for this message. The hash code of a message should mix the
message's type (object identity of the descriptor) with its contents (known and unknown field
values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Get the FieldAccessorTable for this type. We can't have the message
class pass this in to the constructor because of bootstrapping trouble
with DescriptorProtos.
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DescriptorProtos.MessageOptions.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DescriptorProtos.MessageOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Creates a new instance of this message type. Overridden in the generated code.
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public DescriptorProtos.MessageOptions.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Serializes the message and writes it to output. This does not flush or close the
stream.
