public static final class DescriptorProtos.FieldOptions extends GeneratedMessageLite.ExtendableMessage<DescriptorProtos.FieldOptions,DescriptorProtos.FieldOptions.Builder> 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 |
GeneratedMessageLite.ExtendableMessage.ExtensionWriter
GeneratedMessageLite.DefaultInstanceBasedParser<T extends GeneratedMessageLite<T,?>>, GeneratedMessageLite.ExtendableBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.ExtendableMessage<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.GeneratedExtension<ContainingType extends MessageLite,Type>, GeneratedMessageLite.MergeFromVisitor, GeneratedMessageLite.MethodToInvoke, GeneratedMessageLite.SerializedForm, GeneratedMessageLite.Visitor
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 int |
UNINTERPRETED_OPTION_FIELD_NUMBER |
static int |
WEAK_FIELD_NUMBER |
extensions
memoizedSerializedSize, unknownFields
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
protected Object |
dynamicMethod(GeneratedMessageLite.MethodToInvoke method,
Object arg0,
Object arg1)
A method that implements different types of operations described in
GeneratedMessageLite.MethodToInvoke . |
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() |
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.
|
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.
|
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.
|
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.
|
List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> |
getUninterpretedOptionOrBuilderList()
The parser stores options it doesn't recognize here.
|
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.
|
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.
|
static DescriptorProtos.FieldOptions.Builder |
newBuilder() |
static DescriptorProtos.FieldOptions.Builder |
newBuilder(DescriptorProtos.FieldOptions prototype) |
static DescriptorProtos.FieldOptions |
parseDelimitedFrom(InputStream input) |
static DescriptorProtos.FieldOptions |
parseDelimitedFrom(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(InputStream input) |
static DescriptorProtos.FieldOptions |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<DescriptorProtos.FieldOptions> |
parser() |
void |
writeTo(CodedOutputStream output)
Serializes the message and writes it to
output . |
extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getExtension, getExtension, getExtensionCount, hasExtension, makeImmutable, mergeExtensionFields, newExtensionWriter, newMessageSetExtensionWriter, parseUnknownField
dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, toBuilder, toString
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getExtension, getExtension, getExtensionCount, hasExtension
getDefaultInstanceForType, isInitialized
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
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). By default these types are represented as JavaScript strings. This avoids loss of precision that can happen when a large value is converted to a floating point JavaScript numbers. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type instead of strings. 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). By default these types are represented as JavaScript strings. This avoids loss of precision that can happen when a large value is converted to a floating point JavaScript numbers. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type instead of strings. 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 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.
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 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.
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 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 List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> getUninterpretedOptionOrBuilderList()
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
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;
public void writeTo(CodedOutputStream output) throws IOException
MessageLite
output
. This does not
flush or close the stream.writeTo
in interface MessageLite
IOException
public int getSerializedSize()
MessageLite
getSerializedSize
in interface MessageLite
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(InputStream input) throws IOException
IOException
public static DescriptorProtos.FieldOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static DescriptorProtos.FieldOptions parseDelimitedFrom(InputStream input) throws IOException
IOException
public static DescriptorProtos.FieldOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static DescriptorProtos.FieldOptions parseFrom(CodedInputStream input) throws IOException
IOException
public static DescriptorProtos.FieldOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static DescriptorProtos.FieldOptions.Builder newBuilder()
public static DescriptorProtos.FieldOptions.Builder newBuilder(DescriptorProtos.FieldOptions prototype)
protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
GeneratedMessageLite
GeneratedMessageLite.MethodToInvoke
.
Theses different kinds of operations are required to implement message-level operations for
builders in the runtime. This method bundles those operations to reduce the generated methods
count.
MERGE_FROM_STREAM
is parameterized with an CodedInputStream
and
ExtensionRegistryLite
. It consumes the input stream, parsing the contents into the
returned protocol buffer. If parsing throws an InvalidProtocolBufferException
, the
implementation wraps it in a RuntimeException.
NEW_INSTANCE
returns a new instance of the protocol buffer that has not yet been
made immutable. See MAKE_IMMUTABLE
.
IS_INITIALIZED
is parameterized with a Boolean
detailing whether to
memoize. It returns null
for false and the default instance for true. We optionally
memoize to support the Builder case, where memoization is not desired.
NEW_BUILDER
returns a BuilderType
instance.
VISIT
is parameterized with a Visitor
and a MessageType
and
recursively iterates through the fields side by side between this and the instance.
MAKE_IMMUTABLE
sets all internal fields to an immutable state.
For use by generated code only.
dynamicMethod
in class GeneratedMessageLite<DescriptorProtos.FieldOptions,DescriptorProtos.FieldOptions.Builder>
public static DescriptorProtos.FieldOptions getDefaultInstance()
public static Parser<DescriptorProtos.FieldOptions> parser()
Copyright © 2008–2016 Google. All rights reserved.