Package com.google.protobuf
Class DescriptorProtos.FieldOptions
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<DescriptorProtos.FieldOptions>
com.google.protobuf.DescriptorProtos.FieldOptions
- All Implemented Interfaces:
DescriptorProtos.FieldOptionsOrBuilder,GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>,Message,MessageLite,MessageLiteOrBuilder,MessageOrBuilder,Serializable
- Enclosing class:
- DescriptorProtos
public static final class DescriptorProtos.FieldOptions
extends GeneratedMessage.ExtendableMessage<DescriptorProtos.FieldOptions>
implements DescriptorProtos.FieldOptionsOrBuilder
Protobuf type
google.protobuf.FieldOptions- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classProtobuf typegoogle.protobuf.FieldOptionsstatic enumProtobuf enumgoogle.protobuf.FieldOptions.CTypeNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage
GeneratedMessage.ExtendableMessage.ExtensionWriterNested 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
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic Parser<DescriptorProtos.FieldOptions>static final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuildersFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptiongetCtype()optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];Get an instance of the type with no fields set.booleanoptional bool deprecated = 3 [default = false];static final Descriptors.Descriptoroptional string experimental_map_key = 9;optional string experimental_map_key = 9;booleangetLazy()optional bool lazy = 5 [default = false];booleanoptional bool packed = 2;Gets the parser for a message of the same type as this message.intGet the number of bytes required to encode this message.getUninterpretedOption(int index) repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;intrepeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;getUninterpretedOptionOrBuilder(int index) repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;final UnknownFieldSetGet theUnknownFieldSetfor this message.booleangetWeak()optional bool weak = 10 [default = false];booleanhasCtype()optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];booleanoptional bool deprecated = 3 [default = false];booleanoptional string experimental_map_key = 9;booleanhasLazy()optional bool lazy = 5 [default = false];booleanoptional bool packed = 2;booleanhasWeak()optional bool weak = 10 [default = false];protected GeneratedMessage.FieldAccessorTableGet the FieldAccessorTable for this type.final booleanReturns true if all required fields in the message and all embedded messages are set, false otherwise.newBuilder(DescriptorProtos.FieldOptions prototype) Constructs a new builder for a message of the same type as this message.protected DescriptorProtos.FieldOptions.BuilderparseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) parseFrom(ByteString data) parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) parseFrom(CodedInputStream input) parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) Constructs a builder initialized with the current message.protected ObjectReplaces this object in the output stream with a serialized form.voidwriteTo(CodedOutputStream output) Serializes the message and writes it tooutput.Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage
extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, makeExtensionsImmutable, newExtensionWriter, newMessageSetExtensionWriter, parseUnknownFieldMethods inherited from class com.google.protobuf.GeneratedMessage
getDescriptorForType, getOneofFieldDescriptor, hasOneof, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtensionMethods inherited from class com.google.protobuf.AbstractMessage
equals, findInitializationErrors, getInitializationErrorString, hashCode, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder
getExtension, getExtension, getExtensionCount, hasExtensionMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
-
Field Details
-
PARSER
-
CTYPE_FIELD_NUMBER
public static final int CTYPE_FIELD_NUMBER- See Also:
-
PACKED_FIELD_NUMBER
public static final int PACKED_FIELD_NUMBER- See Also:
-
LAZY_FIELD_NUMBER
public static final int LAZY_FIELD_NUMBER- See Also:
-
DEPRECATED_FIELD_NUMBER
public static final int DEPRECATED_FIELD_NUMBER- See Also:
-
EXPERIMENTAL_MAP_KEY_FIELD_NUMBER
public static final int EXPERIMENTAL_MAP_KEY_FIELD_NUMBER- See Also:
-
WEAK_FIELD_NUMBER
public static final int WEAK_FIELD_NUMBER- See Also:
-
UNINTERPRETED_OPTION_FIELD_NUMBER
public static final int UNINTERPRETED_OPTION_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDefaultInstance
-
getDefaultInstanceForType
Description copied from interface:MessageLiteOrBuilderGet 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 thegetDefaultInstance()method of generated message classes in that this method is an abstract method of theMessageLiteinterface whereasgetDefaultInstance()is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForTypein interfaceGeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>- Specified by:
getDefaultInstanceForTypein interfaceMessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfaceMessageOrBuilder
-
getUnknownFields
Description copied from interface:MessageOrBuilderGet theUnknownFieldSetfor this message.- Specified by:
getUnknownFieldsin interfaceMessageOrBuilder- Overrides:
getUnknownFieldsin classGeneratedMessage
-
getDescriptor
-
internalGetFieldAccessorTable
Description copied from class:GeneratedMessageGet 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:
internalGetFieldAccessorTablein classGeneratedMessage
-
getParserForType
Description copied from interface:MessageLiteGets the parser for a message of the same type as this message.- Specified by:
getParserForTypein interfaceMessage- Specified by:
getParserForTypein interfaceMessageLite- Overrides:
getParserForTypein classGeneratedMessage
-
hasCtype
public boolean hasCtype()optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is not yet implemented in the open source release -- sorry, we'll try to include it in a future version!
- Specified by:
hasCtypein interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getCtype
optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is not yet implemented in the open source release -- sorry, we'll try to include it in a future version!
- Specified by:
getCtypein interfaceDescriptorProtos.FieldOptionsOrBuilder
-
hasPacked
public boolean hasPacked()optional bool packed = 2;The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. Rather than repeatedly writing the tag and type for each element, the entire array is encoded as a single length-delimited blob.
- Specified by:
hasPackedin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getPacked
public boolean getPacked()optional bool packed = 2;The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. Rather than repeatedly writing the tag and type for each element, the entire array is encoded as a single length-delimited blob.
- Specified by:
getPackedin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
hasLazy
public boolean hasLazy()optional bool lazy = 5 [default = false];Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed. This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it. This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access. Note that implementations may choose not to check required fields within a lazy sub-message. That is, calling IsInitialized() on the outher message may return true even if the inner message has missing required fields. This is necessary because otherwise the inner message would have to be parsed in order to perform the check, defeating the purpose of lazy parsing. An implementation which chooses not to check required fields must be consistent about it. That is, for any particular sub-message, the implementation must either *always* check its required fields, or *never* check its required fields, regardless of whether or not the message has been parsed.
- Specified by:
hasLazyin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getLazy
public boolean getLazy()optional bool lazy = 5 [default = false];Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed. This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it. This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access. Note that implementations may choose not to check required fields within a lazy sub-message. That is, calling IsInitialized() on the outher message may return true even if the inner message has missing required fields. This is necessary because otherwise the inner message would have to be parsed in order to perform the check, defeating the purpose of lazy parsing. An implementation which chooses not to check required fields must be consistent about it. That is, for any particular sub-message, the implementation must either *always* check its required fields, or *never* check its required fields, regardless of whether or not the message has been parsed.
- Specified by:
getLazyin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
hasDeprecated
public boolean hasDeprecated()optional bool deprecated = 3 [default = false];Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.
- Specified by:
hasDeprecatedin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getDeprecated
public boolean getDeprecated()optional bool deprecated = 3 [default = false];Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.
- Specified by:
getDeprecatedin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
hasExperimentalMapKey
public boolean hasExperimentalMapKey()optional string experimental_map_key = 9;EXPERIMENTAL. DO NOT USE. For "map" fields, the name of the field in the enclosed type that is the key for this map. For example, suppose we have: message Item { required string name = 1; required string value = 2; } message Config { repeated Item items = 1 [experimental_map_key="name"]; } In this situation, the map key for Item will be set to "name". TODO: Fully-implement this, then remove the "experimental_" prefix.- Specified by:
hasExperimentalMapKeyin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getExperimentalMapKey
optional string experimental_map_key = 9;EXPERIMENTAL. DO NOT USE. For "map" fields, the name of the field in the enclosed type that is the key for this map. For example, suppose we have: message Item { required string name = 1; required string value = 2; } message Config { repeated Item items = 1 [experimental_map_key="name"]; } In this situation, the map key for Item will be set to "name". TODO: Fully-implement this, then remove the "experimental_" prefix.- Specified by:
getExperimentalMapKeyin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getExperimentalMapKeyBytes
optional string experimental_map_key = 9;EXPERIMENTAL. DO NOT USE. For "map" fields, the name of the field in the enclosed type that is the key for this map. For example, suppose we have: message Item { required string name = 1; required string value = 2; } message Config { repeated Item items = 1 [experimental_map_key="name"]; } In this situation, the map key for Item will be set to "name". TODO: Fully-implement this, then remove the "experimental_" prefix.- Specified by:
getExperimentalMapKeyBytesin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
hasWeak
public boolean hasWeak()optional bool weak = 10 [default = false];For Google-internal migration only. Do not use.
- Specified by:
hasWeakin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getWeak
public boolean getWeak()optional bool weak = 10 [default = false];For Google-internal migration only. Do not use.
- Specified by:
getWeakin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getUninterpretedOptionList
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;The parser stores options it doesn't recognize here. See above.
- Specified by:
getUninterpretedOptionListin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
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:
getUninterpretedOptionOrBuilderListin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getUninterpretedOptionCount
public int getUninterpretedOptionCount()repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;The parser stores options it doesn't recognize here. See above.
- Specified by:
getUninterpretedOptionCountin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getUninterpretedOption
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;The parser stores options it doesn't recognize here. See above.
- Specified by:
getUninterpretedOptionin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getUninterpretedOptionOrBuilder
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;The parser stores options it doesn't recognize here. See above.
- Specified by:
getUninterpretedOptionOrBuilderin interfaceDescriptorProtos.FieldOptionsOrBuilder
-
isInitialized
public final boolean isInitialized()Description copied from interface:MessageLiteOrBuilderReturns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitializedin interfaceMessageLiteOrBuilder- Overrides:
isInitializedin classGeneratedMessage.ExtendableMessage<DescriptorProtos.FieldOptions>
-
writeTo
Description copied from interface:MessageLiteSerializes the message and writes it tooutput. This does not flush or close the stream.- Specified by:
writeToin interfaceMessageLite- Overrides:
writeToin classAbstractMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()Description copied from interface:MessageLiteGet the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.- Specified by:
getSerializedSizein interfaceMessageLite- Overrides:
getSerializedSizein classAbstractMessage
-
writeReplace
Description copied from class:GeneratedMessageReplaces this object in the output stream with a serialized form. Part of Java's serialization magic. Generated sub-classes must override this method by callingreturn super.writeReplace();- Overrides:
writeReplacein classGeneratedMessage- Returns:
- a SerializedForm of this message
- Throws:
ObjectStreamException
-
parseFrom
public static DescriptorProtos.FieldOptions parseFrom(ByteString data) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static DescriptorProtos.FieldOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static DescriptorProtos.FieldOptions parseFrom(byte[] data) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static DescriptorProtos.FieldOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static DescriptorProtos.FieldOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static DescriptorProtos.FieldOptions parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static DescriptorProtos.FieldOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static DescriptorProtos.FieldOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilder
-
newBuilderForType
Description copied from interface:MessageLiteConstructs a new builder for a message of the same type as this message.- Specified by:
newBuilderForTypein interfaceMessage- Specified by:
newBuilderForTypein interfaceMessageLite
-
newBuilder
public static DescriptorProtos.FieldOptions.Builder newBuilder(DescriptorProtos.FieldOptions prototype) -
toBuilder
Description copied from interface:MessageLiteConstructs a builder initialized with the current message. Use this to derive a new message from the current one.- Specified by:
toBuilderin interfaceMessage- Specified by:
toBuilderin interfaceMessageLite
-
newBuilderForType
protected DescriptorProtos.FieldOptions.Builder newBuilderForType(GeneratedMessage.BuilderParent parent) - Specified by:
newBuilderForTypein classGeneratedMessage
-