com.google.protobuf

Class DescriptorProtos.MessageOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableMessage<DescriptorProtos.MessageOptions>

com.google.protobuf.DescriptorProtos.MessageOptions

All Implemented Interfaces:

DescriptorProtos.MessageOptionsOrBuilder, GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.MessageOptions>, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

Enclosing class:

DescriptorProtos

public static final class DescriptorProtos.MessageOptions
extends GeneratedMessage.ExtendableMessage<DescriptorProtos.MessageOptions>
implements DescriptorProtos.MessageOptionsOrBuilder

Protobuf type google.protobuf.MessageOptions

See Also:

Serialized Form

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

GeneratedMessage.ExtendableMessage.ExtensionWriter

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

GeneratedMessage.BuilderParent, GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder>, GeneratedMessage.ExtendableMessage<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingType extends Message,Type>

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 Parser<DescriptorProtos.MessageOptions>	PARSER
static int	UNINTERPRETED_OPTION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Methods

Modifier and Type	Method and Description
static DescriptorProtos.MessageOptions	getDefaultInstance()
DescriptorProtos.MessageOptions	getDefaultInstanceForType() Get an instance of the type with no fields set.
boolean	getDeprecated() optional bool deprecated = 3 [default = false];
static Descriptors.Descriptor	getDescriptor()
boolean	getMapEntry() optional bool map_entry = 7;
boolean	getMessageSetWireFormat() optional bool message_set_wire_format = 1 [default = false];
boolean	getNoStandardDescriptorAccessor() optional bool no_standard_descriptor_accessor = 2 [default = false];
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) repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
int	getUninterpretedOptionCount() repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
List<DescriptorProtos.UninterpretedOption>	getUninterpretedOptionList() repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
DescriptorProtos.UninterpretedOptionOrBuilder	getUninterpretedOptionOrBuilder(int index) repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
List<? extends DescriptorProtos.UninterpretedOptionOrBuilder>	getUninterpretedOptionOrBuilderList() repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
UnknownFieldSet	getUnknownFields() Get the UnknownFieldSet for this message.
boolean	hasDeprecated() optional bool deprecated = 3 [default = false];
boolean	hasMapEntry() optional bool map_entry = 7;
boolean	hasMessageSetWireFormat() optional bool message_set_wire_format = 1 [default = false];
boolean	hasNoStandardDescriptorAccessor() optional bool no_standard_descriptor_accessor = 2 [default = false];
protected GeneratedMessage.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(GeneratedMessage.BuilderParent parent)
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)
DescriptorProtos.MessageOptions.Builder	toBuilder() Constructs a builder initialized with the current message.
void	writeTo(CodedOutputStream output) Serializes the message and writes it to output.

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

extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, makeExtensionsImmutable, newExtensionWriter, newMessageSetExtensionWriter, parseUnknownField

Methods inherited from class com.google.protobuf.GeneratedMessage

getDescriptorForType, getOneofFieldDescriptor, hasOneof, internalGetMapField, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension, writeReplace

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashCode, hashFields, 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.GeneratedMessage.ExtendableMessageOrBuilder

getExtension, getExtension, getExtensionCount, hasExtension

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

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

PARSER

public static final Parser<DescriptorProtos.MessageOptions> PARSER

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessage

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Description copied from class: GeneratedMessage

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.

Specified by:

internalGetFieldAccessorTable in class GeneratedMessage

hasMessageSetWireFormat

public boolean hasMessageSetWireFormat()

optional bool message_set_wire_format = 1 [default = false];

 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.
 

Specified by:

hasMessageSetWireFormat in interface DescriptorProtos.MessageOptionsOrBuilder

getMessageSetWireFormat

public boolean getMessageSetWireFormat()

optional bool message_set_wire_format = 1 [default = false];

 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.
 

Specified by:

getMessageSetWireFormat in interface DescriptorProtos.MessageOptionsOrBuilder

hasNoStandardDescriptorAccessor

public boolean hasNoStandardDescriptorAccessor()

optional bool no_standard_descriptor_accessor = 2 [default = false];

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

Specified by:

hasNoStandardDescriptorAccessor in interface DescriptorProtos.MessageOptionsOrBuilder

getNoStandardDescriptorAccessor

public boolean getNoStandardDescriptorAccessor()

optional bool no_standard_descriptor_accessor = 2 [default = false];

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

Specified by:

getNoStandardDescriptorAccessor in interface DescriptorProtos.MessageOptionsOrBuilder

hasDeprecated

public boolean hasDeprecated()

optional bool deprecated = 3 [default = false];

 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.
 

Specified by:

hasDeprecated in interface DescriptorProtos.MessageOptionsOrBuilder

getDeprecated

public boolean getDeprecated()

optional bool deprecated = 3 [default = false];

 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.
 

Specified by:

getDeprecated in interface DescriptorProtos.MessageOptionsOrBuilder

hasMapEntry

public boolean hasMapEntry()

optional bool map_entry = 7;

 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.
 

Specified by:

hasMapEntry in interface DescriptorProtos.MessageOptionsOrBuilder

getMapEntry

public boolean getMapEntry()

optional bool map_entry = 7;

 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.
 

Specified by:

getMapEntry in interface DescriptorProtos.MessageOptionsOrBuilder

getUninterpretedOptionList

public List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

 The parser stores options it doesn't recognize here. See above.
 

Specified by:

getUninterpretedOptionList in interface DescriptorProtos.MessageOptionsOrBuilder

getUninterpretedOptionOrBuilderList

public List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> getUninterpretedOptionOrBuilderList()

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

 The parser stores options it doesn't recognize here. See above.
 

Specified by:

getUninterpretedOptionOrBuilderList in interface DescriptorProtos.MessageOptionsOrBuilder

getUninterpretedOptionCount

public int getUninterpretedOptionCount()

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

 The parser stores options it doesn't recognize here. See above.
 

Specified by:

getUninterpretedOptionCount in interface DescriptorProtos.MessageOptionsOrBuilder

getUninterpretedOption

public DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

 The parser stores options it doesn't recognize here. See above.
 

Specified by:

getUninterpretedOption in interface DescriptorProtos.MessageOptionsOrBuilder

getUninterpretedOptionOrBuilder

public DescriptorProtos.UninterpretedOptionOrBuilder getUninterpretedOptionOrBuilder(int index)

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

 The parser stores options it doesn't recognize here. See above.
 

Specified by:

getUninterpretedOptionOrBuilder in interface DescriptorProtos.MessageOptionsOrBuilder

isInitialized

public final boolean isInitialized()

Description copied from interface: MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage.ExtendableMessage<DescriptorProtos.MessageOptions>

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

Overrides:

writeTo in class GeneratedMessage

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

Overrides:

getSerializedSize in class GeneratedMessage

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

newBuilderForType

public DescriptorProtos.MessageOptions.Builder newBuilderForType()

Description copied from interface: MessageLite

Constructs a new builder for a message of the same type as this message.

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static DescriptorProtos.MessageOptions.Builder newBuilder()

newBuilder

public static DescriptorProtos.MessageOptions.Builder newBuilder(DescriptorProtos.MessageOptions prototype)

toBuilder

public DescriptorProtos.MessageOptions.Builder toBuilder()

Description copied from interface: MessageLite

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected DescriptorProtos.MessageOptions.Builder newBuilderForType(GeneratedMessage.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessage

getDefaultInstance

public static DescriptorProtos.MessageOptions getDefaultInstance()

getParserForType

public Parser<DescriptorProtos.MessageOptions> getParserForType()

Description copied from interface: MessageLite

Gets the parser for a message of the same type as this message.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessage

getDefaultInstanceForType

public DescriptorProtos.MessageOptions getDefaultInstanceForType()

Description copied from interface: MessageLiteOrBuilder

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.

Specified by:

getDefaultInstanceForType in interface GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.MessageOptions>

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder