com.google.protobuf

Class DescriptorProtos.MessageOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>

com.google.protobuf.GeneratedMessageLite<MessageType,BuilderType>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DescriptorProtos.MessageOptions.Builder Protobuf type google.protobuf.MessageOptions

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite.ExtendableMessage

GeneratedMessageLite.ExtendableMessage.ExtensionWriter

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

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

Field Summary

Fields

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

Fields inherited from class com.google.protobuf.GeneratedMessageLite.ExtendableMessage

extensions

Fields inherited from class com.google.protobuf.GeneratedMessageLite

memoizedSerializedSize, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

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.

Methods inherited from class com.google.protobuf.GeneratedMessageLite.ExtendableMessage

extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getExtension, getExtension, getExtensionCount, hasExtension, makeImmutable, mergeExtensionFields, newExtensionWriter, newMessageSetExtensionWriter, parseUnknownField

Methods inherited from class com.google.protobuf.GeneratedMessageLite

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

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder

getExtension, getExtension, getExtensionCount, hasExtension

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

getDefaultInstanceForType, isInitialized

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

MAP_ENTRY_FIELD_NUMBER

public static final int MAP_ENTRY_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

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

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

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

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

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

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

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

Specified by:

hasMapEntry in interface DescriptorProtos.MessageOptionsOrBuilder

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

Specified by:

getMapEntry in interface DescriptorProtos.MessageOptionsOrBuilder

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;

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Description copied from interface: MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Description copied from interface: MessageLite

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.

Specified by:

getSerializedSize in interface MessageLite

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

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()