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

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DescriptorProtos.FieldOptions.Builder Protobuf type google.protobuf.FieldOptions
static class	DescriptorProtos.FieldOptions.CType Protobuf enum google.protobuf.FieldOptions.CType

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

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	CTYPE_FIELD_NUMBER
static int	DEPRECATED_FIELD_NUMBER
static int	EXPERIMENTAL_MAP_KEY_FIELD_NUMBER
static int	LAZY_FIELD_NUMBER
static int	PACKED_FIELD_NUMBER
static Parser<DescriptorProtos.FieldOptions>	PARSER
static int	UNINTERPRETED_OPTION_FIELD_NUMBER
static int	WEAK_FIELD_NUMBER

Method Summary

Methods

Modifier and Type	Method and Description
DescriptorProtos.FieldOptions.CType	getCtype() optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
static DescriptorProtos.FieldOptions	getDefaultInstance()
DescriptorProtos.FieldOptions	getDefaultInstanceForType() Get an instance of the type with no fields set.
boolean	getDeprecated() optional bool deprecated = 3 [default = false];
static Descriptors.Descriptor	getDescriptor()
java.lang.String	getExperimentalMapKey() optional string experimental_map_key = 9;
ByteString	getExperimentalMapKeyBytes() optional string experimental_map_key = 9;
boolean	getLazy() optional bool lazy = 5 [default = false];
boolean	getPacked() optional bool packed = 2;
Parser<DescriptorProtos.FieldOptions>	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;
java.util.List<DescriptorProtos.UninterpretedOption>	getUninterpretedOptionList() repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
DescriptorProtos.UninterpretedOptionOrBuilder	getUninterpretedOptionOrBuilder(int index) repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
java.util.List<? extends DescriptorProtos.UninterpretedOptionOrBuilder>	getUninterpretedOptionOrBuilderList() repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
UnknownFieldSet	getUnknownFields() Get the UnknownFieldSet for this message.
boolean	getWeak() optional bool weak = 10 [default = false];
boolean	hasCtype() optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
boolean	hasDeprecated() optional bool deprecated = 3 [default = false];
boolean	hasExperimentalMapKey() optional string experimental_map_key = 9;
boolean	hasLazy() optional bool lazy = 5 [default = false];
boolean	hasPacked() optional bool packed = 2;
boolean	hasWeak() optional bool weak = 10 [default = false];
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
static DescriptorProtos.FieldOptions.Builder	newBuilder()
static DescriptorProtos.FieldOptions.Builder	newBuilder(DescriptorProtos.FieldOptions prototype)
DescriptorProtos.FieldOptions.Builder	newBuilderForType() Constructs a new builder for a message of the same type as this message.
static DescriptorProtos.FieldOptions	parseDelimitedFrom(java.io.InputStream input)
static DescriptorProtos.FieldOptions	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static DescriptorProtos.FieldOptions	parseFrom(byte[] data)
static DescriptorProtos.FieldOptions	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static DescriptorProtos.FieldOptions	parseFrom(ByteString data)
static DescriptorProtos.FieldOptions	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static DescriptorProtos.FieldOptions	parseFrom(CodedInputStream input)
static DescriptorProtos.FieldOptions	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static DescriptorProtos.FieldOptions	parseFrom(java.io.InputStream input)
static DescriptorProtos.FieldOptions	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
DescriptorProtos.FieldOptions.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

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

Methods inherited from class com.google.protobuf.GeneratedMessage

getDescriptorForType, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension

Methods inherited from class com.google.protobuf.AbstractMessage

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

getExtension, getExtension, getExtensionCount, hasExtension

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARSER

public static Parser<DescriptorProtos.FieldOptions> PARSER

CTYPE_FIELD_NUMBER

public static final int CTYPE_FIELD_NUMBER

See Also:

Constant Field Values

PACKED_FIELD_NUMBER

public static final int PACKED_FIELD_NUMBER

See Also:

Constant Field Values

LAZY_FIELD_NUMBER

public static final int LAZY_FIELD_NUMBER

See Also:

Constant Field Values

DEPRECATED_FIELD_NUMBER

public static final int DEPRECATED_FIELD_NUMBER

See Also:

Constant Field Values

EXPERIMENTAL_MAP_KEY_FIELD_NUMBER

public static final int EXPERIMENTAL_MAP_KEY_FIELD_NUMBER

See Also:

Constant Field Values

WEAK_FIELD_NUMBER

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

getDefaultInstance

public static DescriptorProtos.FieldOptions getDefaultInstance()

getDefaultInstanceForType

public DescriptorProtos.FieldOptions 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 MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

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

getParserForType

public Parser<DescriptorProtos.FieldOptions> 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

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:

hasCtype in interface DescriptorProtos.FieldOptionsOrBuilder

getCtype

public DescriptorProtos.FieldOptions.CType 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:

getCtype in interface DescriptorProtos.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:

hasPacked in interface DescriptorProtos.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:

getPacked in interface DescriptorProtos.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:

hasLazy in interface DescriptorProtos.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:

getLazy in interface DescriptorProtos.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:

hasDeprecated in interface DescriptorProtos.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:

getDeprecated in interface DescriptorProtos.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:

hasExperimentalMapKey in interface DescriptorProtos.FieldOptionsOrBuilder

getExperimentalMapKey

public java.lang.String 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:

getExperimentalMapKey in interface DescriptorProtos.FieldOptionsOrBuilder

getExperimentalMapKeyBytes

public ByteString 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:

getExperimentalMapKeyBytes in interface DescriptorProtos.FieldOptionsOrBuilder

hasWeak

public boolean hasWeak()

optional bool weak = 10 [default = false];

 For Google-internal migration only. Do not use.
 

Specified by:

hasWeak in interface DescriptorProtos.FieldOptionsOrBuilder

getWeak

public boolean getWeak()

optional bool weak = 10 [default = false];

 For Google-internal migration only. Do not use.
 

Specified by:

getWeak in interface DescriptorProtos.FieldOptionsOrBuilder

getUninterpretedOptionList

public java.util.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.FieldOptionsOrBuilder

getUninterpretedOptionOrBuilderList

public java.util.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.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:

getUninterpretedOptionCount in interface DescriptorProtos.FieldOptionsOrBuilder

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

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

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

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 AbstractMessage

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 AbstractMessage

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

public static DescriptorProtos.FieldOptions parseFrom(java.io.InputStream input)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilder

public static DescriptorProtos.FieldOptions.Builder newBuilder()

newBuilderForType

public DescriptorProtos.FieldOptions.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.FieldOptions.Builder newBuilder(DescriptorProtos.FieldOptions prototype)

toBuilder

public DescriptorProtos.FieldOptions.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