@Generated(value="proto") public static final class DescriptorProtos.FieldOptions extends GeneratedMessageV3.ExtendableMessage<DescriptorProtos.FieldOptions> implements DescriptorProtos.FieldOptionsOrBuilder
google.protobuf.FieldOptions
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 |
static class |
DescriptorProtos.FieldOptions.JSType
Protobuf enum
google.protobuf.FieldOptions.JSType |
GeneratedMessageV3.ExtendableMessage.ExtensionWriter
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable
Modifier and Type | Field and Description |
---|---|
static int |
CTYPE_FIELD_NUMBER |
static int |
DEPRECATED_FIELD_NUMBER |
static int |
JSTYPE_FIELD_NUMBER |
static int |
LAZY_FIELD_NUMBER |
static int |
PACKED_FIELD_NUMBER |
static Parser<DescriptorProtos.FieldOptions> |
PARSER
Deprecated.
|
static int |
UNINTERPRETED_OPTION_FIELD_NUMBER |
static int |
WEAK_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Compares the specified object with this message for equality.
|
DescriptorProtos.FieldOptions.CType |
getCtype()
The ctype option instructs the C++ code generator to use a different
representation of the field than it normally would.
|
static DescriptorProtos.FieldOptions |
getDefaultInstance() |
DescriptorProtos.FieldOptions |
getDefaultInstanceForType()
Get an instance of the type with no fields set.
|
boolean |
getDeprecated()
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.
|
static Descriptors.Descriptor |
getDescriptor() |
DescriptorProtos.FieldOptions.JSType |
getJstype()
The jstype option determines the JavaScript type used for values of the
field.
|
boolean |
getLazy()
Should this field be parsed lazily? Lazy applies only to message-type
fields.
|
boolean |
getPacked()
The packed option can be enabled for repeated primitive fields to enable
a more efficient representation on the wire.
|
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)
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.
|
UnknownFieldSet |
getUnknownFields()
Get the
UnknownFieldSet for this message. |
boolean |
getWeak()
For Google-internal migration only.
|
boolean |
hasCtype()
The ctype option instructs the C++ code generator to use a different
representation of the field than it normally would.
|
boolean |
hasDeprecated()
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.
|
int |
hashCode()
Returns the hash code value for this message.
|
boolean |
hasJstype()
The jstype option determines the JavaScript type used for values of the
field.
|
boolean |
hasLazy()
Should this field be parsed lazily? Lazy applies only to message-type
fields.
|
boolean |
hasPacked()
The packed option can be enabled for repeated primitive fields to enable
a more efficient representation on the wire.
|
boolean |
hasWeak()
For Google-internal migration only.
|
protected GeneratedMessageV3.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.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.
|
protected DescriptorProtos.FieldOptions.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
|
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(java.nio.ByteBuffer data) |
static DescriptorProtos.FieldOptions |
parseFrom(java.nio.ByteBuffer 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) |
static Parser<DescriptorProtos.FieldOptions> |
parser() |
DescriptorProtos.FieldOptions.Builder |
toBuilder()
Constructs a builder initialized with the current message.
|
void |
writeTo(CodedOutputStream output)
Serializes the message and writes it to
output . |
extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasExtension, hasExtension, hasField, makeExtensionsImmutable, newExtensionWriter, newMessageSetExtensionWriter, parseUnknownField, parseUnknownFieldProto3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, hasOneof, internalGetMapField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int CTYPE_FIELD_NUMBER
public static final int PACKED_FIELD_NUMBER
public static final int JSTYPE_FIELD_NUMBER
public static final int LAZY_FIELD_NUMBER
public static final int DEPRECATED_FIELD_NUMBER
public static final int WEAK_FIELD_NUMBER
public static final int UNINTERPRETED_OPTION_FIELD_NUMBER
@Deprecated public static final Parser<DescriptorProtos.FieldOptions> PARSER
public final UnknownFieldSet getUnknownFields()
MessageOrBuilder
UnknownFieldSet
for this message.getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
GeneratedMessageV3
internalGetFieldAccessorTable
in class GeneratedMessageV3
public boolean hasCtype()
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!
optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
hasCtype
in interface DescriptorProtos.FieldOptionsOrBuilder
public DescriptorProtos.FieldOptions.CType getCtype()
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!
optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
getCtype
in interface DescriptorProtos.FieldOptionsOrBuilder
public boolean hasPacked()
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. In proto3, only explicit setting it to false will avoid using packed encoding.
optional bool packed = 2;
hasPacked
in interface DescriptorProtos.FieldOptionsOrBuilder
public boolean getPacked()
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. In proto3, only explicit setting it to false will avoid using packed encoding.
optional bool packed = 2;
getPacked
in interface DescriptorProtos.FieldOptionsOrBuilder
public boolean hasJstype()
The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent. This option is an enum to permit additional types to be added, e.g. goog.math.Integer.
optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];
hasJstype
in interface DescriptorProtos.FieldOptionsOrBuilder
public DescriptorProtos.FieldOptions.JSType getJstype()
The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent. This option is an enum to permit additional types to be added, e.g. goog.math.Integer.
optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];
getJstype
in interface DescriptorProtos.FieldOptionsOrBuilder
public boolean hasLazy()
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 outer 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.
optional bool lazy = 5 [default = false];
hasLazy
in interface DescriptorProtos.FieldOptionsOrBuilder
public boolean getLazy()
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 outer 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.
optional bool lazy = 5 [default = false];
getLazy
in interface DescriptorProtos.FieldOptionsOrBuilder
public boolean hasDeprecated()
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.
optional bool deprecated = 3 [default = false];
hasDeprecated
in interface DescriptorProtos.FieldOptionsOrBuilder
public boolean getDeprecated()
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.
optional bool deprecated = 3 [default = false];
getDeprecated
in interface DescriptorProtos.FieldOptionsOrBuilder
public boolean hasWeak()
For Google-internal migration only. Do not use.
optional bool weak = 10 [default = false];
hasWeak
in interface DescriptorProtos.FieldOptionsOrBuilder
public boolean getWeak()
For Google-internal migration only. Do not use.
optional bool weak = 10 [default = false];
getWeak
in interface DescriptorProtos.FieldOptionsOrBuilder
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;
getUninterpretedOptionList
in interface DescriptorProtos.FieldOptionsOrBuilder
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;
getUninterpretedOptionOrBuilderList
in interface DescriptorProtos.FieldOptionsOrBuilder
public int getUninterpretedOptionCount()
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
getUninterpretedOptionCount
in interface DescriptorProtos.FieldOptionsOrBuilder
public DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
getUninterpretedOption
in interface DescriptorProtos.FieldOptionsOrBuilder
public DescriptorProtos.UninterpretedOptionOrBuilder getUninterpretedOptionOrBuilder(int index)
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
getUninterpretedOptionOrBuilder
in interface DescriptorProtos.FieldOptionsOrBuilder
public final boolean isInitialized()
MessageLiteOrBuilder
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3.ExtendableMessage<DescriptorProtos.FieldOptions>
public void writeTo(CodedOutputStream output) throws java.io.IOException
MessageLite
output
. This does not flush or close the
stream.writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
MessageLite
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(java.lang.Object obj)
Message
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.equals
in interface Message
equals
in class AbstractMessage
obj
- object to be compared for equality with this messagetrue
if the specified object is equal to this messagepublic int hashCode()
Message
Object.hashCode()
is incorrect.hashCode
in interface Message
hashCode
in class AbstractMessage
Map.hashCode()
public static DescriptorProtos.FieldOptions parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DescriptorProtos.FieldOptions parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DescriptorProtos.FieldOptions parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DescriptorProtos.FieldOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DescriptorProtos.FieldOptions parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DescriptorProtos.FieldOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DescriptorProtos.FieldOptions parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static DescriptorProtos.FieldOptions parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static DescriptorProtos.FieldOptions parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static DescriptorProtos.FieldOptions parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static DescriptorProtos.FieldOptions parseFrom(CodedInputStream input) throws java.io.IOException
java.io.IOException
public static DescriptorProtos.FieldOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public DescriptorProtos.FieldOptions.Builder newBuilderForType()
MessageLite
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static DescriptorProtos.FieldOptions.Builder newBuilder()
public static DescriptorProtos.FieldOptions.Builder newBuilder(DescriptorProtos.FieldOptions prototype)
public DescriptorProtos.FieldOptions.Builder toBuilder()
MessageLite
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected DescriptorProtos.FieldOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
GeneratedMessageV3
newBuilderForType
in class GeneratedMessageV3
public static DescriptorProtos.FieldOptions getDefaultInstance()
public static Parser<DescriptorProtos.FieldOptions> parser()
public Parser<DescriptorProtos.FieldOptions> getParserForType()
MessageLite
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public DescriptorProtos.FieldOptions getDefaultInstanceForType()
MessageLiteOrBuilder
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.getDefaultInstanceForType
in interface GeneratedMessageV3.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.