Package com.google.protobuf
Class DescriptorProtos.FieldOptions
java.lang.Object
- All Implemented Interfaces:
DescriptorProtos.FieldOptionsOrBuilder
,GeneratedMessageLite.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions,
,DescriptorProtos.FieldOptions.Builder> MessageLite
,MessageLiteOrBuilder
- Enclosing class:
DescriptorProtos
public static final class DescriptorProtos.FieldOptions
extends GeneratedMessageLite.ExtendableMessage<DescriptorProtos.FieldOptions,DescriptorProtos.FieldOptions.Builder>
implements DescriptorProtos.FieldOptionsOrBuilder
Protobuf type
google.protobuf.FieldOptions
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Protobuf typegoogle.protobuf.FieldOptions
static enum
Protobuf enumgoogle.protobuf.FieldOptions.CType
static final class
Protobuf typegoogle.protobuf.FieldOptions.EditionDefault
static interface
static final class
Information about the support window of a feature.static interface
static enum
Protobuf enumgoogle.protobuf.FieldOptions.JSType
static enum
If set to RETENTION_SOURCE, the option will be omitted from the binary.static enum
This indicates the types of entities that the field may apply to when used as an option.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite.ExtendableMessage
GeneratedMessageLite.ExtendableMessage.ExtensionWriter
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite
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.ExtensionDescriptor, GeneratedMessageLite.GeneratedExtension<ContainingType extends MessageLite, Type>, GeneratedMessageLite.MethodToInvoke, GeneratedMessageLite.SerializedForm Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private int
static final int
static final int
private boolean
private static final DescriptorProtos.FieldOptions
private boolean
static final int
static final int
static final int
private DescriptorProtos.FeatureSet
static final int
private int
static final int
private boolean
static final int
private byte
private boolean
static final int
private static Parser
<DescriptorProtos.FieldOptions> private int
static final int
private Internal.IntList
private static final Internal.IntListAdapter.IntConverter
<DescriptorProtos.FieldOptions.OptionTargetType> static final int
static final int
static final int
private boolean
private boolean
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageLite.ExtendableMessage
extensions
Fields inherited from class com.google.protobuf.GeneratedMessageLite
UNINITIALIZED_HASH_CODE, UNINITIALIZED_SERIALIZED_SIZE, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addAllEditionDefaults
(Iterable<? extends DescriptorProtos.FieldOptions.EditionDefault> values) repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
private void
addAllTargets
(Iterable<? extends DescriptorProtos.FieldOptions.OptionTargetType> values) repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
private void
addAllUninterpretedOption
(Iterable<? extends DescriptorProtos.UninterpretedOption> values) The parser stores options it doesn't recognize here.private void
addEditionDefaults
(int index, DescriptorProtos.FieldOptions.EditionDefault value) repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
private void
repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
private void
repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
private void
addUninterpretedOption
(int index, DescriptorProtos.UninterpretedOption value) The parser stores options it doesn't recognize here.private void
The parser stores options it doesn't recognize here.private void
NOTE: ctype is deprecated.private void
Indicate that the field value should not be printed out when using debug formats, e.g.private void
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.private void
repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
private void
Any features defined in the specific edition.private void
optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
private void
The jstype option determines the JavaScript type used for values of the field.private void
Should this field be parsed lazily? Lazy applies only to message-type fields.private void
The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.private void
optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
private void
repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
private void
The parser stores options it doesn't recognize here.private void
unverified_lazy does no correctness checks on the byte stream.private void
For Google-internal migration only.protected final Object
dynamicMethod
(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) A method that implements different types of operations described inGeneratedMessageLite.MethodToInvoke
.private void
private void
private void
getCtype()
NOTE: ctype is deprecated.boolean
Indicate that the field value should not be printed out when using debug formats, e.g.boolean
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.getEditionDefaults
(int index) repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
int
repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
getEditionDefaultsOrBuilder
(int index) repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
Any features defined in the specific edition.optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
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
The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
getTargets
(int index) repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
int
repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
getUninterpretedOption
(int index) The parser stores options it doesn't recognize here.int
The parser stores options it doesn't recognize here.The parser stores options it doesn't recognize here.getUninterpretedOptionOrBuilder
(int index) The parser stores options it doesn't recognize here.The parser stores options it doesn't recognize here.boolean
unverified_lazy does no correctness checks on the byte stream.boolean
getWeak()
For Google-internal migration only.boolean
hasCtype()
NOTE: ctype is deprecated.boolean
Indicate that the field value should not be printed out when using debug formats, e.g.boolean
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
Any features defined in the specific edition.boolean
optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
boolean
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
The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.boolean
optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
boolean
unverified_lazy does no correctness checks on the byte stream.boolean
hasWeak()
For Google-internal migration only.private void
Any features defined in the specific edition.private void
optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
newBuilder
(DescriptorProtos.FieldOptions prototype) parseDelimitedFrom
(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) parseFrom
(ByteBuffer data) parseFrom
(ByteBuffer data, ExtensionRegistryLite extensionRegistry) static Parser
<DescriptorProtos.FieldOptions> parser()
private void
removeEditionDefaults
(int index) repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
private void
removeUninterpretedOption
(int index) The parser stores options it doesn't recognize here.private void
NOTE: ctype is deprecated.private void
setDebugRedact
(boolean value) Indicate that the field value should not be printed out when using debug formats, e.g.private void
setDeprecated
(boolean value) 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.private void
setEditionDefaults
(int index, DescriptorProtos.FieldOptions.EditionDefault value) repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
private void
Any features defined in the specific edition.private void
optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
private void
The jstype option determines the JavaScript type used for values of the field.private void
setLazy
(boolean value) Should this field be parsed lazily? Lazy applies only to message-type fields.private void
setPacked
(boolean value) The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.private void
optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
private void
setTargets
(int index, DescriptorProtos.FieldOptions.OptionTargetType value) repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
private void
setUninterpretedOption
(int index, DescriptorProtos.UninterpretedOption value) The parser stores options it doesn't recognize here.private void
setUnverifiedLazy
(boolean value) unverified_lazy does no correctness checks on the byte stream.private void
setWeak
(boolean value) For Google-internal migration only.Methods inherited from class com.google.protobuf.GeneratedMessageLite.ExtendableMessage
ensureExtensionsAreMutable, extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getExtension, getExtension, getExtensionCount, hasExtension, mergeExtensionFields, newExtensionWriter, newMessageSetExtensionWriter, parseUnknownField, parseUnknownFieldAsMessageSet
Methods inherited from class com.google.protobuf.GeneratedMessageLite
buildMessageInfo, clearMemoizedHashCode, clearMemoizedSerializedSize, computeHashCode, createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstance, getDefaultInstanceForType, getMemoizedHashCode, getMemoizedSerializedSize, getMethodOrDie, getParserForType, getSerializedSize, getSerializedSize, hashCode, hashCodeIsNotMemoized, invokeOrDie, isInitialized, isInitialized, isMutable, makeImmutable, markImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newMutableInstance, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, setMemoizedHashCode, setMemoizedSerializedSize, toBuilder, toString, writeTo
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, newUninitializedMessageException, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder
getExtension, getExtension, getExtensionCount, hasExtension
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Field Details
-
bitField0_
private int bitField0_ -
CTYPE_FIELD_NUMBER
public static final int CTYPE_FIELD_NUMBER- See Also:
-
ctype_
private int ctype_ -
PACKED_FIELD_NUMBER
public static final int PACKED_FIELD_NUMBER- See Also:
-
packed_
private boolean packed_ -
JSTYPE_FIELD_NUMBER
public static final int JSTYPE_FIELD_NUMBER- See Also:
-
jstype_
private int jstype_ -
LAZY_FIELD_NUMBER
public static final int LAZY_FIELD_NUMBER- See Also:
-
lazy_
private boolean lazy_ -
UNVERIFIED_LAZY_FIELD_NUMBER
public static final int UNVERIFIED_LAZY_FIELD_NUMBER- See Also:
-
unverifiedLazy_
private boolean unverifiedLazy_ -
DEPRECATED_FIELD_NUMBER
public static final int DEPRECATED_FIELD_NUMBER- See Also:
-
deprecated_
private boolean deprecated_ -
WEAK_FIELD_NUMBER
public static final int WEAK_FIELD_NUMBER- See Also:
-
weak_
private boolean weak_ -
DEBUG_REDACT_FIELD_NUMBER
public static final int DEBUG_REDACT_FIELD_NUMBER- See Also:
-
debugRedact_
private boolean debugRedact_ -
RETENTION_FIELD_NUMBER
public static final int RETENTION_FIELD_NUMBER- See Also:
-
retention_
private int retention_ -
TARGETS_FIELD_NUMBER
public static final int TARGETS_FIELD_NUMBER- See Also:
-
targets_
-
targets_converter_
private static final Internal.IntListAdapter.IntConverter<DescriptorProtos.FieldOptions.OptionTargetType> targets_converter_ -
EDITION_DEFAULTS_FIELD_NUMBER
public static final int EDITION_DEFAULTS_FIELD_NUMBER- See Also:
-
editionDefaults_
-
FEATURES_FIELD_NUMBER
public static final int FEATURES_FIELD_NUMBER- See Also:
-
features_
-
FEATURE_SUPPORT_FIELD_NUMBER
public static final int FEATURE_SUPPORT_FIELD_NUMBER- See Also:
-
featureSupport_
-
UNINTERPRETED_OPTION_FIELD_NUMBER
public static final int UNINTERPRETED_OPTION_FIELD_NUMBER- See Also:
-
uninterpretedOption_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
FieldOptions
private FieldOptions()
-
-
Method Details
-
hasCtype
public boolean hasCtype()NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead. 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 only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated.
optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
- Specified by:
hasCtype
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the ctype field is set.
-
getCtype
NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead. 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 only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated.
optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
- Specified by:
getCtype
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The ctype.
-
setCtype
NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead. 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 only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated.
optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
- Parameters:
value
- The ctype to set.
-
clearCtype
private void clearCtype()NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead. 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 only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated.
optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
-
hasPacked
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. This option is prohibited in Editions, but the `repeated_field_encoding` feature can be used to control the behavior.
optional bool packed = 2;
- Specified by:
hasPacked
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the packed field is set.
-
getPacked
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. This option is prohibited in Editions, but the `repeated_field_encoding` feature can be used to control the behavior.
optional bool packed = 2;
- Specified by:
getPacked
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The packed.
-
setPacked
private void setPacked(boolean value) 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. This option is prohibited in Editions, but the `repeated_field_encoding` feature can be used to control the behavior.
optional bool packed = 2;
- Parameters:
value
- The packed to set.
-
clearPacked
private void clearPacked()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. This option is prohibited in Editions, but the `repeated_field_encoding` feature can be used to control the behavior.
optional bool packed = 2;
-
hasJstype
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];
- Specified by:
hasJstype
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the jstype field is set.
-
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];
- Specified by:
getJstype
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The jstype.
-
setJstype
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];
- Parameters:
value
- The jstype to set.
-
clearJstype
private void clearJstype()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];
-
hasLazy
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 lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable).
optional bool lazy = 5 [default = false];
- Specified by:
hasLazy
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the lazy field is set.
-
getLazy
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 lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable).
optional bool lazy = 5 [default = false];
- Specified by:
getLazy
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The lazy.
-
setLazy
private void setLazy(boolean value) 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 lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable).
optional bool lazy = 5 [default = false];
- Parameters:
value
- The lazy to set.
-
clearLazy
private void clearLazy()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 lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable).
optional bool lazy = 5 [default = false];
-
hasUnverifiedLazy
public boolean hasUnverifiedLazy()unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.
optional bool unverified_lazy = 15 [default = false];
- Specified by:
hasUnverifiedLazy
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the unverifiedLazy field is set.
-
getUnverifiedLazy
public boolean getUnverifiedLazy()unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.
optional bool unverified_lazy = 15 [default = false];
- Specified by:
getUnverifiedLazy
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The unverifiedLazy.
-
setUnverifiedLazy
private void setUnverifiedLazy(boolean value) unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.
optional bool unverified_lazy = 15 [default = false];
- Parameters:
value
- The unverifiedLazy to set.
-
clearUnverifiedLazy
private void clearUnverifiedLazy()unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.
optional bool unverified_lazy = 15 [default = false];
-
hasDeprecated
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];
- Specified by:
hasDeprecated
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the deprecated field is set.
-
getDeprecated
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];
- Specified by:
getDeprecated
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The deprecated.
-
setDeprecated
private void setDeprecated(boolean value) 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];
- Parameters:
value
- The deprecated to set.
-
clearDeprecated
private void clearDeprecated()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];
-
hasWeak
public boolean hasWeak()For Google-internal migration only. Do not use.
optional bool weak = 10 [default = false];
- Specified by:
hasWeak
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the weak field is set.
-
getWeak
public boolean getWeak()For Google-internal migration only. Do not use.
optional bool weak = 10 [default = false];
- Specified by:
getWeak
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The weak.
-
setWeak
private void setWeak(boolean value) For Google-internal migration only. Do not use.
optional bool weak = 10 [default = false];
- Parameters:
value
- The weak to set.
-
clearWeak
private void clearWeak()For Google-internal migration only. Do not use.
optional bool weak = 10 [default = false];
-
hasDebugRedact
public boolean hasDebugRedact()Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.
optional bool debug_redact = 16 [default = false];
- Specified by:
hasDebugRedact
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the debugRedact field is set.
-
getDebugRedact
public boolean getDebugRedact()Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.
optional bool debug_redact = 16 [default = false];
- Specified by:
getDebugRedact
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The debugRedact.
-
setDebugRedact
private void setDebugRedact(boolean value) Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.
optional bool debug_redact = 16 [default = false];
- Parameters:
value
- The debugRedact to set.
-
clearDebugRedact
private void clearDebugRedact()Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.
optional bool debug_redact = 16 [default = false];
-
hasRetention
public boolean hasRetention()optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
- Specified by:
hasRetention
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the retention field is set.
-
getRetention
optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
- Specified by:
getRetention
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The retention.
-
setRetention
optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
- Parameters:
value
- The retention to set.
-
clearRetention
private void clearRetention()optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
-
getTargetsList
repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
- Specified by:
getTargetsList
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- A list containing the targets.
-
getTargetsCount
public int getTargetsCount()repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
- Specified by:
getTargetsCount
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The count of targets.
-
getTargets
repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
- Specified by:
getTargets
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The targets at the given index.
-
ensureTargetsIsMutable
private void ensureTargetsIsMutable() -
setTargets
repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
- Parameters:
index
- The index to set the value at.value
- The targets to set.
-
addTargets
repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
- Parameters:
value
- The targets to add.
-
addAllTargets
private void addAllTargets(Iterable<? extends DescriptorProtos.FieldOptions.OptionTargetType> values) repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
- Parameters:
values
- The targets to add.
-
clearTargets
private void clearTargets()repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
-
getEditionDefaultsList
repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
- Specified by:
getEditionDefaultsList
in interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getEditionDefaultsOrBuilderList
public List<? extends DescriptorProtos.FieldOptions.EditionDefaultOrBuilder> getEditionDefaultsOrBuilderList()repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
-
getEditionDefaultsCount
public int getEditionDefaultsCount()repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
- Specified by:
getEditionDefaultsCount
in interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getEditionDefaults
repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
- Specified by:
getEditionDefaults
in interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getEditionDefaultsOrBuilder
repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
-
ensureEditionDefaultsIsMutable
private void ensureEditionDefaultsIsMutable() -
setEditionDefaults
repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
-
addEditionDefaults
repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
-
addEditionDefaults
repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
-
addAllEditionDefaults
private void addAllEditionDefaults(Iterable<? extends DescriptorProtos.FieldOptions.EditionDefault> values) repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
-
clearEditionDefaults
private void clearEditionDefaults()repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
-
removeEditionDefaults
private void removeEditionDefaults(int index) repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
-
hasFeatures
public boolean hasFeatures()Any features defined in the specific edition.
optional .google.protobuf.FeatureSet features = 21;
- Specified by:
hasFeatures
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the features field is set.
-
getFeatures
Any features defined in the specific edition.
optional .google.protobuf.FeatureSet features = 21;
- Specified by:
getFeatures
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The features.
-
setFeatures
Any features defined in the specific edition.
optional .google.protobuf.FeatureSet features = 21;
-
mergeFeatures
Any features defined in the specific edition.
optional .google.protobuf.FeatureSet features = 21;
-
clearFeatures
private void clearFeatures()Any features defined in the specific edition.
optional .google.protobuf.FeatureSet features = 21;
-
hasFeatureSupport
public boolean hasFeatureSupport()optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
- Specified by:
hasFeatureSupport
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the featureSupport field is set.
-
getFeatureSupport
optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
- Specified by:
getFeatureSupport
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The featureSupport.
-
setFeatureSupport
optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
-
mergeFeatureSupport
optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
-
clearFeatureSupport
private void clearFeatureSupport()optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
-
getUninterpretedOptionList
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
- Specified by:
getUninterpretedOptionList
in interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getUninterpretedOptionOrBuilderList
public List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> getUninterpretedOptionOrBuilderList()The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
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 interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getUninterpretedOption
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
- Specified by:
getUninterpretedOption
in interfaceDescriptorProtos.FieldOptionsOrBuilder
-
getUninterpretedOptionOrBuilder
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
ensureUninterpretedOptionIsMutable
private void ensureUninterpretedOptionIsMutable() -
setUninterpretedOption
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
addUninterpretedOption
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
addUninterpretedOption
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
addAllUninterpretedOption
private void addAllUninterpretedOption(Iterable<? extends DescriptorProtos.UninterpretedOption> values) The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
clearUninterpretedOption
private void clearUninterpretedOption()The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
removeUninterpretedOption
private void removeUninterpretedOption(int index) The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
parseFrom
public static DescriptorProtos.FieldOptions parseFrom(ByteBuffer data) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static DescriptorProtos.FieldOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
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
-
newBuilder
public static DescriptorProtos.FieldOptions.Builder newBuilder(DescriptorProtos.FieldOptions prototype) -
dynamicMethod
protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) Description copied from class:GeneratedMessageLite
A method that implements different types of operations described inGeneratedMessageLite.MethodToInvoke
. These 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.NEW_INSTANCE
returns a new instance of the protocol buffer that has not yet been made immutable. SeeMAKE_IMMUTABLE
.IS_INITIALIZED
returnsnull
for false and the default instance for true. It doesn't use or modify any memoized value.GET_MEMOIZED_IS_INITIALIZED
returns the memoizedisInitialized
byte value.SET_MEMOIZED_IS_INITIALIZED
sets the memoizedisInitialized
byte value to 1 if the first parameter is not null, or to 0 if the first parameter is null.NEW_BUILDER
returns aBuilderType
instance.
For use by generated code only.
- Specified by:
dynamicMethod
in classGeneratedMessageLite<DescriptorProtos.FieldOptions,
DescriptorProtos.FieldOptions.Builder>
-
getDefaultInstance
-
parser
-