com.google.protobuf

Class DescriptorProtos.MessageOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

com.google.protobuf.DescriptorProtos.MessageOptions

All Implemented Interfaces:

DescriptorProtos.MessageOptionsOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<DescriptorProtos.MessageOptions>, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

Enclosing class:

DescriptorProtos

public static final class DescriptorProtos.MessageOptions
extends com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

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 Deprecated.
static int	UNINTERPRETED_OPTION_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.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.
java.util.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.
java.util.List<? extends DescriptorProtos.UninterpretedOptionOrBuilder>	getUninterpretedOptionOrBuilderList() The parser stores options it doesn't recognize here.
com.google.protobuf.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.
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.
static DescriptorProtos.MessageOptions	parseDelimitedFrom(java.io.InputStream input)
static DescriptorProtos.MessageOptions	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static DescriptorProtos.MessageOptions	parseFrom(byte[] data)
static DescriptorProtos.MessageOptions	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static DescriptorProtos.MessageOptions	parseFrom(java.nio.ByteBuffer data)
static DescriptorProtos.MessageOptions	parseFrom(java.nio.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(java.io.InputStream input)
static DescriptorProtos.MessageOptions	parseFrom(java.io.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.

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

getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasExtension, hasExtension, hasField

Methods inherited from class com.google.protobuf.GeneratedMessageV3

getDescriptorForType, getOneofFieldDescriptor, hasOneof

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, 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

@Deprecated
public static final Parser<DescriptorProtos.MessageOptions> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

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

Returns:

Whether the messageSetWireFormat field is set.

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

Returns:

The messageSetWireFormat.

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

Returns:

Whether the noStandardDescriptorAccessor field is set.

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

Returns:

The noStandardDescriptorAccessor.

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

Returns:

Whether the deprecated field is set.

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

Returns:

The deprecated.

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;

Specified by:

hasMapEntry in interface DescriptorProtos.MessageOptionsOrBuilder

Returns:

Whether the mapEntry field is set.

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;

Specified by:

getMapEntry in interface DescriptorProtos.MessageOptionsOrBuilder

Returns:

The mapEntry.

getUninterpretedOptionList

public java.util.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 java.util.List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> getUninterpretedOptionOrBuilderList()

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Specified by:

getUninterpretedOptionOrBuilderList in interface DescriptorProtos.MessageOptionsOrBuilder

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;

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 com.google.protobuf.GeneratedMessageV3.ExtendableMessage<DescriptorProtos.MessageOptions>

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.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 com.google.protobuf.GeneratedMessageV3

Throws:

java.io.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 com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: Message

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.

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

Parameters:

obj - object to be compared for equality with this message

Returns:

true if the specified object is equal to this message

hashCode

public int hashCode()

Description copied from interface: Message

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.

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

Returns:

the hash code value for this message

See Also:

Map.hashCode()

parseFrom

public static DescriptorProtos.MessageOptions parseFrom(java.nio.ByteBuffer data)
                                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DescriptorProtos.MessageOptions parseFrom(java.nio.ByteBuffer data,
                                                        ExtensionRegistryLite extensionRegistry)
                                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

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(java.io.InputStream input)
                                                 throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static DescriptorProtos.MessageOptions parseFrom(java.io.InputStream input,
                                                        ExtensionRegistryLite extensionRegistry)
                                                 throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static DescriptorProtos.MessageOptions parseDelimitedFrom(java.io.InputStream input)
                                                          throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static DescriptorProtos.MessageOptions parseDelimitedFrom(java.io.InputStream input,
                                                                 ExtensionRegistryLite extensionRegistry)
                                                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static DescriptorProtos.MessageOptions parseFrom(CodedInputStream input)
                                                 throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static DescriptorProtos.MessageOptions parseFrom(CodedInputStream input,
                                                        ExtensionRegistryLite extensionRegistry)
                                                 throws java.io.IOException

Throws:

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

getDefaultInstance

public static DescriptorProtos.MessageOptions getDefaultInstance()

parser

public static Parser<DescriptorProtos.MessageOptions> parser()

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 com.google.protobuf.GeneratedMessageV3

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 com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<DescriptorProtos.MessageOptions>

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder