public static final class DescriptorProtos.MessageOptions extends GeneratedMessageLite.ExtendableMessage<DescriptorProtos.MessageOptions,DescriptorProtos.MessageOptions.Builder> implements DescriptorProtos.MessageOptionsOrBuilder
google.protobuf.MessageOptions
Modifier and Type | Class and Description |
---|---|
static class |
DescriptorProtos.MessageOptions.Builder
Protobuf type
google.protobuf.MessageOptions |
GeneratedMessageLite.ExtendableMessage.ExtensionWriter
GeneratedMessageLite.DefaultInstanceBasedParser<T extends GeneratedMessageLite<T,?>>, GeneratedMessageLite.ExtendableBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.ExtendableMessage<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.GeneratedExtension<ContainingType extends MessageLite,Type>, GeneratedMessageLite.MergeFromVisitor, GeneratedMessageLite.MethodToInvoke, GeneratedMessageLite.SerializedForm, GeneratedMessageLite.Visitor
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 int |
UNINTERPRETED_OPTION_FIELD_NUMBER |
extensions
memoizedSerializedSize, unknownFields
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
protected Object |
dynamicMethod(GeneratedMessageLite.MethodToInvoke method,
Object arg0,
Object arg1)
A method that implements different types of operations described in
GeneratedMessageLite.MethodToInvoke . |
static DescriptorProtos.MessageOptions |
getDefaultInstance() |
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.
|
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.
|
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.
|
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.
|
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.
|
static DescriptorProtos.MessageOptions.Builder |
newBuilder() |
static DescriptorProtos.MessageOptions.Builder |
newBuilder(DescriptorProtos.MessageOptions prototype) |
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(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() |
void |
writeTo(CodedOutputStream output)
Serializes the message and writes it to
output . |
extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getExtension, getExtension, getExtensionCount, hasExtension, makeImmutable, mergeExtensionFields, newExtensionWriter, newMessageSetExtensionWriter, parseUnknownField
dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, toBuilder, toString
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getExtension, getExtension, getExtensionCount, hasExtension
getDefaultInstanceForType, isInitialized
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
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 implementions 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 implementions 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;
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;
public void writeTo(CodedOutputStream output) throws IOException
MessageLite
output
. This does not
flush or close the stream.writeTo
in interface MessageLite
IOException
public int getSerializedSize()
MessageLite
getSerializedSize
in interface MessageLite
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 static DescriptorProtos.MessageOptions.Builder newBuilder()
public static DescriptorProtos.MessageOptions.Builder newBuilder(DescriptorProtos.MessageOptions prototype)
protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
GeneratedMessageLite
GeneratedMessageLite.MethodToInvoke
.
Theses 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.
MERGE_FROM_STREAM
is parameterized with an CodedInputStream
and
ExtensionRegistryLite
. It consumes the input stream, parsing the contents into the
returned protocol buffer. If parsing throws an InvalidProtocolBufferException
, the
implementation wraps it in a RuntimeException.
NEW_INSTANCE
returns a new instance of the protocol buffer that has not yet been
made immutable. See MAKE_IMMUTABLE
.
IS_INITIALIZED
is parameterized with a Boolean
detailing whether to
memoize. It returns null
for false and the default instance for true. We optionally
memoize to support the Builder case, where memoization is not desired.
NEW_BUILDER
returns a BuilderType
instance.
VISIT
is parameterized with a Visitor
and a MessageType
and
recursively iterates through the fields side by side between this and the instance.
MAKE_IMMUTABLE
sets all internal fields to an immutable state.
For use by generated code only.
dynamicMethod
in class GeneratedMessageLite<DescriptorProtos.MessageOptions,DescriptorProtos.MessageOptions.Builder>
public static DescriptorProtos.MessageOptions getDefaultInstance()
public static Parser<DescriptorProtos.MessageOptions> parser()
Copyright © 2008–2016 Google. All rights reserved.