public static final class DescriptorProtos.MessageOptions extends GeneratedMessageV3.ExtendableMessage<DescriptorProtos.MessageOptions> implements DescriptorProtos.MessageOptionsOrBuilder
google.protobuf.MessageOptions
Modifier and Type | Class and Description |
---|---|
static class |
DescriptorProtos.MessageOptions.Builder
Protobuf type
google.protobuf.MessageOptions |
GeneratedMessageV3.ExtendableMessage.ExtensionWriter
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
DEPRECATED_FIELD_NUMBER |
static int |
MAP_ENTRY_FIELD_NUMBER |
static int |
MESSAGE_SET_WIRE_FORMAT_FIELD_NUMBER |
static int |
NO_STANDARD_DESCRIPTOR_ACCESSOR_FIELD_NUMBER |
static Parser<DescriptorProtos.MessageOptions> |
PARSER
Deprecated.
|
static int |
UNINTERPRETED_OPTION_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Compares the specified object with this message for equality.
|
static DescriptorProtos.MessageOptions |
getDefaultInstance() |
DescriptorProtos.MessageOptions |
getDefaultInstanceForType()
Get an instance of the type with no fields set.
|
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.
|
static Descriptors.Descriptor |
getDescriptor() |
boolean |
getMapEntry()
Whether the message is an automatically generated map entry type for the
maps field.
|
boolean |
getMessageSetWireFormat()
Set true to use the old proto1 MessageSet wire format for extensions.
|
boolean |
getNoStandardDescriptorAccessor()
Disables the generation of the standard "descriptor()" accessor, which can
conflict with a field of the same name.
|
Parser<DescriptorProtos.MessageOptions> |
getParserForType()
Gets the parser for a message of the same type as this message.
|
int |
getSerializedSize()
Get the number of bytes required to encode this message.
|
DescriptorProtos.UninterpretedOption |
getUninterpretedOption(int index)
The parser stores options it doesn't recognize here.
|
int |
getUninterpretedOptionCount()
The parser stores options it doesn't recognize here.
|
List<DescriptorProtos.UninterpretedOption> |
getUninterpretedOptionList()
The parser stores options it doesn't recognize here.
|
DescriptorProtos.UninterpretedOptionOrBuilder |
getUninterpretedOptionOrBuilder(int index)
The parser stores options it doesn't recognize here.
|
List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> |
getUninterpretedOptionOrBuilderList()
The parser stores options it doesn't recognize here.
|
UnknownFieldSet |
getUnknownFields()
Get the
UnknownFieldSet for this message. |
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.
|
int |
hashCode()
Returns the hash code value for this message.
|
boolean |
hasMapEntry()
Whether the message is an automatically generated map entry type for the
maps field.
|
boolean |
hasMessageSetWireFormat()
Set true to use the old proto1 MessageSet wire format for extensions.
|
boolean |
hasNoStandardDescriptorAccessor()
Disables the generation of the standard "descriptor()" accessor, which can
conflict with a field of the same name.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable()
Get the FieldAccessorTable for this type.
|
boolean |
isInitialized()
Returns true if all required fields in the message and all embedded messages are set, false
otherwise.
|
static DescriptorProtos.MessageOptions.Builder |
newBuilder() |
static DescriptorProtos.MessageOptions.Builder |
newBuilder(DescriptorProtos.MessageOptions prototype) |
DescriptorProtos.MessageOptions.Builder |
newBuilderForType()
Constructs a new builder for a message of the same type as this message.
|
protected DescriptorProtos.MessageOptions.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
|
protected Object |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Creates a new instance of this message type.
|
static DescriptorProtos.MessageOptions |
parseDelimitedFrom(InputStream input) |
static DescriptorProtos.MessageOptions |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static DescriptorProtos.MessageOptions |
parseFrom(byte[] data) |
static DescriptorProtos.MessageOptions |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static DescriptorProtos.MessageOptions |
parseFrom(ByteBuffer data) |
static DescriptorProtos.MessageOptions |
parseFrom(ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static DescriptorProtos.MessageOptions |
parseFrom(ByteString data) |
static DescriptorProtos.MessageOptions |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static DescriptorProtos.MessageOptions |
parseFrom(CodedInputStream input) |
static DescriptorProtos.MessageOptions |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static DescriptorProtos.MessageOptions |
parseFrom(InputStream input) |
static DescriptorProtos.MessageOptions |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<DescriptorProtos.MessageOptions> |
parser() |
DescriptorProtos.MessageOptions.Builder |
toBuilder()
Constructs a builder initialized with the current message.
|
void |
writeTo(CodedOutputStream output)
Serializes the message and writes it to
output . |
extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasExtension, hasExtension, hasField, makeExtensionsImmutable, newExtensionWriter, newMessageSetExtensionWriter, parseUnknownField, parseUnknownFieldProto3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, hasOneof, internalGetMapField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, getSerializedSizeInternal, isInitializedInternal, makeImmutableInternal, mergeFromInternal, toByteArray, toByteString, writeDelimitedTo, writeTo, writeToInternal
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int MESSAGE_SET_WIRE_FORMAT_FIELD_NUMBER
public static final int NO_STANDARD_DESCRIPTOR_ACCESSOR_FIELD_NUMBER
public static final int DEPRECATED_FIELD_NUMBER
public static final int MAP_ENTRY_FIELD_NUMBER
public static final int UNINTERPRETED_OPTION_FIELD_NUMBER
@Deprecated public static final Parser<DescriptorProtos.MessageOptions> PARSER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
GeneratedMessageV3
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
MessageOrBuilder
UnknownFieldSet
for this message.getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
GeneratedMessageV3
internalGetFieldAccessorTable
in class GeneratedMessageV3
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];
hasMessageSetWireFormat
in interface DescriptorProtos.MessageOptionsOrBuilder
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];
getMessageSetWireFormat
in interface DescriptorProtos.MessageOptionsOrBuilder
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];
hasNoStandardDescriptorAccessor
in interface DescriptorProtos.MessageOptionsOrBuilder
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];
getNoStandardDescriptorAccessor
in interface DescriptorProtos.MessageOptionsOrBuilder
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];
hasDeprecated
in interface DescriptorProtos.MessageOptionsOrBuilder
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];
getDeprecated
in interface DescriptorProtos.MessageOptionsOrBuilder
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;
hasMapEntry
in interface DescriptorProtos.MessageOptionsOrBuilder
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;
getMapEntry
in interface DescriptorProtos.MessageOptionsOrBuilder
public List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
getUninterpretedOptionList
in interface DescriptorProtos.MessageOptionsOrBuilder
public List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> getUninterpretedOptionOrBuilderList()
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
getUninterpretedOptionOrBuilderList
in interface DescriptorProtos.MessageOptionsOrBuilder
public int getUninterpretedOptionCount()
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
getUninterpretedOptionCount
in interface DescriptorProtos.MessageOptionsOrBuilder
public DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
getUninterpretedOption
in interface DescriptorProtos.MessageOptionsOrBuilder
public DescriptorProtos.UninterpretedOptionOrBuilder getUninterpretedOptionOrBuilder(int index)
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
getUninterpretedOptionOrBuilder
in interface DescriptorProtos.MessageOptionsOrBuilder
public final boolean isInitialized()
MessageLiteOrBuilder
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3.ExtendableMessage<DescriptorProtos.MessageOptions>
public void writeTo(CodedOutputStream output) throws IOException
MessageLite
output
. This does not flush or close the
stream.writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
MessageLite
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
Message
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.equals
in interface Message
equals
in class AbstractMessage
obj
- object to be compared for equality with this messagetrue
if the specified object is equal to this messagepublic int hashCode()
Message
Object.hashCode()
is incorrect.hashCode
in interface Message
hashCode
in class AbstractMessage
Map.hashCode()
public static DescriptorProtos.MessageOptions parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DescriptorProtos.MessageOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DescriptorProtos.MessageOptions parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DescriptorProtos.MessageOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DescriptorProtos.MessageOptions parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DescriptorProtos.MessageOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DescriptorProtos.MessageOptions parseFrom(InputStream input) throws IOException
IOException
public static DescriptorProtos.MessageOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static DescriptorProtos.MessageOptions parseDelimitedFrom(InputStream input) throws IOException
IOException
public static DescriptorProtos.MessageOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static DescriptorProtos.MessageOptions parseFrom(CodedInputStream input) throws IOException
IOException
public static DescriptorProtos.MessageOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public DescriptorProtos.MessageOptions.Builder newBuilderForType()
MessageLite
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static DescriptorProtos.MessageOptions.Builder newBuilder()
public static DescriptorProtos.MessageOptions.Builder newBuilder(DescriptorProtos.MessageOptions prototype)
public DescriptorProtos.MessageOptions.Builder toBuilder()
MessageLite
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected DescriptorProtos.MessageOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
GeneratedMessageV3
newBuilderForType
in class GeneratedMessageV3
public static DescriptorProtos.MessageOptions getDefaultInstance()
public static Parser<DescriptorProtos.MessageOptions> parser()
public Parser<DescriptorProtos.MessageOptions> getParserForType()
MessageLite
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public DescriptorProtos.MessageOptions getDefaultInstanceForType()
MessageLiteOrBuilder
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.getDefaultInstanceForType
in interface GeneratedMessageV3.ExtendableMessageOrBuilder<DescriptorProtos.MessageOptions>
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2008–2019. All rights reserved.