Class DescriptorProtos.FieldOptions.Builder
- All Implemented Interfaces:
DescriptorProtos.FieldOptionsOrBuilder
,GeneratedMessageV3.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>
,Message.Builder
,MessageLite.Builder
,MessageLiteOrBuilder
,MessageOrBuilder
,Cloneable
- Enclosing class:
- DescriptorProtos.FieldOptions
google.protobuf.FieldOptions
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private int
private boolean
private boolean
private int
private boolean
private boolean
private int
private int
private List<DescriptorProtos.UninterpretedOption>
private RepeatedFieldBuilderV3<DescriptorProtos.UninterpretedOption,
DescriptorProtos.UninterpretedOption.Builder, DescriptorProtos.UninterpretedOptionOrBuilder> private boolean
private boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAllTargets
(Iterable<? extends DescriptorProtos.FieldOptions.OptionTargetType> values) repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
addAllUninterpretedOption
(Iterable<? extends DescriptorProtos.UninterpretedOption> values) The parser stores options it doesn't recognize here.addExtension
(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions, List<Type>> extension, Type value) Append a value to a repeated extension.addRepeatedField
(Descriptors.FieldDescriptor field, Object value) LikesetRepeatedField
, but appends the value as a new element.repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
addUninterpretedOption
(int index, DescriptorProtos.UninterpretedOption value) The parser stores options it doesn't recognize here.addUninterpretedOption
(int index, DescriptorProtos.UninterpretedOption.Builder builderForValue) The parser stores options it doesn't recognize here.The parser stores options it doesn't recognize here.addUninterpretedOption
(DescriptorProtos.UninterpretedOption.Builder builderForValue) The parser stores options it doesn't recognize here.The parser stores options it doesn't recognize here.addUninterpretedOptionBuilder
(int index) The parser stores options it doesn't recognize here.build()
Constructs the message based on the state of the Builder.LikeMessageLite.Builder.build()
, but does not throw an exception if the message is missing required fields.private void
private void
clear()
Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.The ctype option instructs the C++ code generator to use a different representation of the field than it normally would.Indicate that the field value should not be printed out when using debug formats, e.g.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.Clears an extension.Clears the field.The jstype option determines the JavaScript type used for values of the field.Should this field be parsed lazily? Lazy applies only to message-type fields.TODO(jieluo): Clear it when all subclasses have implemented this method.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;
Deprecated.google.protobuf.FieldOptions.target is deprecated.repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
The parser stores options it doesn't recognize here.unverified_lazy does no correctness checks on the byte stream.For Google-internal migration only.clone()
Clones the Builder.private void
private void
getCtype()
The ctype option instructs the C++ code generator to use a different representation of the field than it normally would.boolean
Indicate that the field value should not be printed out when using debug formats, e.g.Get an instance of the type with no fields set.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.static final Descriptors.Descriptor
Get the message's type's descriptor.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;
Deprecated.google.protobuf.FieldOptions.target is deprecated.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.getUninterpretedOptionBuilder
(int index) The parser stores options it doesn't recognize here.The parser stores options it doesn't recognize here.int
The parser stores options it doesn't recognize here.private RepeatedFieldBuilderV3<DescriptorProtos.UninterpretedOption,
DescriptorProtos.UninterpretedOption.Builder, DescriptorProtos.UninterpretedOptionOrBuilder> 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()
The ctype option instructs the C++ code generator to use a different representation of the field than it normally would.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
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
Deprecated.google.protobuf.FieldOptions.target is deprecated.boolean
unverified_lazy does no correctness checks on the byte stream.boolean
hasWeak()
For Google-internal migration only.protected GeneratedMessageV3.FieldAccessorTable
Get the FieldAccessorTable for this type.final boolean
Returns true if all required fields in the message and all embedded messages are set, false otherwise.mergeFrom
(CodedInputStream input, ExtensionRegistryLite extensionRegistry) LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions.Mergeother
into the message being built.mergeUnknownFields
(UnknownFieldSet unknownFields) Merge some unknown fields into theUnknownFieldSet
for this message.removeUninterpretedOption
(int index) The parser stores options it doesn't recognize here.The ctype option instructs the C++ code generator to use a different representation of the field than it normally would.setDebugRedact
(boolean value) Indicate that the field value should not be printed out when using debug formats, e.g.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.setExtension
(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions, List<Type>> extension, int index, Type value) Set the value of one element of a repeated extension.setExtension
(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions, Type> extension, Type value) Set the value of an extension.setField
(Descriptors.FieldDescriptor field, Object value) Sets a field to the given value.The jstype option determines the JavaScript type used for values of the field.setLazy
(boolean value) Should this field be parsed lazily? Lazy applies only to message-type fields.setPacked
(boolean value) The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.setRepeatedField
(Descriptors.FieldDescriptor field, int index, Object value) Sets an element of a repeated field to the given value.optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
Deprecated.google.protobuf.FieldOptions.target is deprecated.setTargets
(int index, DescriptorProtos.FieldOptions.OptionTargetType value) repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
setUninterpretedOption
(int index, DescriptorProtos.UninterpretedOption value) The parser stores options it doesn't recognize here.setUninterpretedOption
(int index, DescriptorProtos.UninterpretedOption.Builder builderForValue) The parser stores options it doesn't recognize here.setUnknownFields
(UnknownFieldSet unknownFields) Set theUnknownFieldSet
for this message.setUnverifiedLazy
(boolean value) unverified_lazy does no correctness checks on the byte stream.setWeak
(boolean value) For Google-internal migration only.Methods inherited from class com.google.protobuf.GeneratedMessageV3.ExtendableBuilder
addExtension, addExtension, clearExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, getField, getFieldBuilder, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, hasExtension, hasExtension, hasExtension, hasField, internalSetExtensionSet, mergeExtensionFields, newBuilderForField, parseUnknownField, setExtension, setExtension, setExtension, setExtension
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
dispose, getOneofFieldDescriptor, getParentForChildren, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder
getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
bitField0_
private int bitField0_ -
ctype_
private int ctype_ -
packed_
private boolean packed_ -
jstype_
private int jstype_ -
lazy_
private boolean lazy_ -
unverifiedLazy_
private boolean unverifiedLazy_ -
deprecated_
private boolean deprecated_ -
weak_
private boolean weak_ -
debugRedact_
private boolean debugRedact_ -
retention_
private int retention_ -
target_
private int target_ -
targets_
-
uninterpretedOption_
-
uninterpretedOptionBuilder_
private RepeatedFieldBuilderV3<DescriptorProtos.UninterpretedOption,DescriptorProtos.UninterpretedOption.Builder, uninterpretedOptionBuilder_DescriptorProtos.UninterpretedOptionOrBuilder>
-
-
Constructor Details
-
Builder
private Builder() -
Builder
-
-
Method Details
-
getDescriptor
-
internalGetFieldAccessorTable
Description copied from class:GeneratedMessageV3.Builder
Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.- Specified by:
internalGetFieldAccessorTable
in classGeneratedMessageV3.Builder<DescriptorProtos.FieldOptions.Builder>
-
clear
Description copied from class:GeneratedMessageV3.Builder
Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.- Specified by:
clear
in interfaceMessage.Builder
- Specified by:
clear
in interfaceMessageLite.Builder
- Overrides:
clear
in classGeneratedMessageV3.ExtendableBuilder<DescriptorProtos.FieldOptions,
DescriptorProtos.FieldOptions.Builder>
-
getDescriptorForType
Description copied from interface:Message.Builder
Get the message's type's descriptor. SeeMessageOrBuilder.getDescriptorForType()
.- Specified by:
getDescriptorForType
in interfaceMessage.Builder
- Specified by:
getDescriptorForType
in interfaceMessageOrBuilder
- Overrides:
getDescriptorForType
in classGeneratedMessageV3.Builder<DescriptorProtos.FieldOptions.Builder>
-
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 thegetDefaultInstance()
method of generated message classes in that this method is an abstract method of theMessageLite
interface whereasgetDefaultInstance()
is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForType
in interfaceGeneratedMessageV3.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>
- Specified by:
getDefaultInstanceForType
in interfaceMessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfaceMessageOrBuilder
-
build
Description copied from interface:MessageLite.Builder
Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.- Specified by:
build
in interfaceMessage.Builder
- Specified by:
build
in interfaceMessageLite.Builder
-
buildPartial
Description copied from interface:MessageLite.Builder
LikeMessageLite.Builder.build()
, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.- Specified by:
buildPartial
in interfaceMessage.Builder
- Specified by:
buildPartial
in interfaceMessageLite.Builder
-
buildPartialRepeatedFields
-
buildPartial0
-
clone
Description copied from interface:MessageLite.Builder
Clones the Builder.- Specified by:
clone
in interfaceMessage.Builder
- Specified by:
clone
in interfaceMessageLite.Builder
- Overrides:
clone
in classGeneratedMessageV3.Builder<DescriptorProtos.FieldOptions.Builder>
- See Also:
-
setField
public DescriptorProtos.FieldOptions.Builder setField(Descriptors.FieldDescriptor field, Object value) Description copied from interface:Message.Builder
Sets a field to the given value. The value must be of the correct type for this field, that is, the same type thatMessageOrBuilder.getField(Descriptors.FieldDescriptor)
returns.- Specified by:
setField
in interfaceMessage.Builder
- Overrides:
setField
in classGeneratedMessageV3.ExtendableBuilder<DescriptorProtos.FieldOptions,
DescriptorProtos.FieldOptions.Builder>
-
clearField
Description copied from interface:Message.Builder
Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.- Specified by:
clearField
in interfaceMessage.Builder
- Overrides:
clearField
in classGeneratedMessageV3.ExtendableBuilder<DescriptorProtos.FieldOptions,
DescriptorProtos.FieldOptions.Builder>
-
clearOneof
Description copied from class:AbstractMessage.Builder
TODO(jieluo): Clear it when all subclasses have implemented this method.- Specified by:
clearOneof
in interfaceMessage.Builder
- Overrides:
clearOneof
in classGeneratedMessageV3.Builder<DescriptorProtos.FieldOptions.Builder>
-
setRepeatedField
public DescriptorProtos.FieldOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value) Description copied from interface:Message.Builder
Sets an element of a repeated field to the given value. The value must be of the correct type for this field; that is, the same type thatMessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int)
returns.- Specified by:
setRepeatedField
in interfaceMessage.Builder
- Overrides:
setRepeatedField
in classGeneratedMessageV3.ExtendableBuilder<DescriptorProtos.FieldOptions,
DescriptorProtos.FieldOptions.Builder>
-
addRepeatedField
public DescriptorProtos.FieldOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value) Description copied from interface:Message.Builder
LikesetRepeatedField
, but appends the value as a new element.- Specified by:
addRepeatedField
in interfaceMessage.Builder
- Overrides:
addRepeatedField
in classGeneratedMessageV3.ExtendableBuilder<DescriptorProtos.FieldOptions,
DescriptorProtos.FieldOptions.Builder>
-
setExtension
public <Type> DescriptorProtos.FieldOptions.Builder setExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions, Type> extension, Type value) Description copied from class:GeneratedMessageV3.ExtendableBuilder
Set the value of an extension.TODO(b/258340024): handled by ExtensionLite version
-
setExtension
public <Type> DescriptorProtos.FieldOptions.Builder setExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions, List<Type>> extension, int index, Type value) Description copied from class:GeneratedMessageV3.ExtendableBuilder
Set the value of one element of a repeated extension.TODO(b/258340024): handled by ExtensionLite version
-
addExtension
public <Type> DescriptorProtos.FieldOptions.Builder addExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions, List<Type>> extension, Type value) Description copied from class:GeneratedMessageV3.ExtendableBuilder
Append a value to a repeated extension.TODO(b/258340024): handled by ExtensionLite version
-
clearExtension
public <T> DescriptorProtos.FieldOptions.Builder clearExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions, T> extension) Description copied from class:GeneratedMessageV3.ExtendableBuilder
Clears an extension.TODO(b/258340024): handled by ExtensionLite version
-
mergeFrom
Description copied from interface:Message.Builder
Mergeother
into the message being built.other
must have the exact same type asthis
(i.e.getDescriptorForType() == other.getDescriptorForType()
).Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set inother
, thenother
's value overwrites the value in this message.
* For singular message fields, if the field is set inother
, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements inother
are concatenated with the elements in this message.
* For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.This is equivalent to the
Message::MergeFrom
method in C++.- Specified by:
mergeFrom
in interfaceMessage.Builder
- Overrides:
mergeFrom
in classAbstractMessage.Builder<DescriptorProtos.FieldOptions.Builder>
-
mergeFrom
-
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.- Specified by:
isInitialized
in interfaceMessageLiteOrBuilder
- Overrides:
isInitialized
in classGeneratedMessageV3.ExtendableBuilder<DescriptorProtos.FieldOptions,
DescriptorProtos.FieldOptions.Builder>
-
mergeFrom
public DescriptorProtos.FieldOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from interface:MessageLite.Builder
LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions. The extensions that you want to be able to parse must be registered inextensionRegistry
. Extensions not in the registry will be treated as unknown fields.- Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfaceMessageLite.Builder
- Overrides:
mergeFrom
in classAbstractMessage.Builder<DescriptorProtos.FieldOptions.Builder>
- Throws:
InvalidProtocolBufferException
- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.IOException
- an I/O error reading from the stream
-
hasCtype
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 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 -- sorry, we'll try to include other types in a future version!
optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
- Specified by:
hasCtype
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the ctype field is set.
-
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 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 -- sorry, we'll try to include other types in a future version!
optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
- Specified by:
getCtype
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The ctype.
-
setCtype
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 -- sorry, we'll try to include other types in a future version!
optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
- Parameters:
value
- The ctype to set.- Returns:
- This builder for chaining.
-
clearCtype
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 -- sorry, we'll try to include other types in a future version!
optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
- Returns:
- This builder for chaining.
-
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.
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.
optional bool packed = 2;
- Specified by:
getPacked
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The packed.
-
setPacked
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;
- Parameters:
value
- The packed to set.- Returns:
- This builder for chaining.
-
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.
optional bool packed = 2;
- Returns:
- This builder for chaining.
-
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.- Returns:
- This builder for chaining.
-
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];
- Returns:
- This builder for chaining.
-
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 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. As of May 2022, lazy verifies the contents of the byte stream during parsing. An invalid byte stream will cause the overall parsing to fail.
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 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. As of May 2022, lazy verifies the contents of the byte stream during parsing. An invalid byte stream will cause the overall parsing to fail.
optional bool lazy = 5 [default = false];
- Specified by:
getLazy
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The lazy.
-
setLazy
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. As of May 2022, lazy verifies the contents of the byte stream during parsing. An invalid byte stream will cause the overall parsing to fail.
optional bool lazy = 5 [default = false];
- Parameters:
value
- The lazy to set.- Returns:
- This builder for chaining.
-
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 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. As of May 2022, lazy verifies the contents of the byte stream during parsing. An invalid byte stream will cause the overall parsing to fail.
optional bool lazy = 5 [default = false];
- Returns:
- This builder for chaining.
-
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
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.- Returns:
- This builder for chaining.
-
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];
- Returns:
- This builder for chaining.
-
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
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.- Returns:
- This builder for chaining.
-
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];
- Returns:
- This builder for chaining.
-
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
For Google-internal migration only. Do not use.
optional bool weak = 10 [default = false];
- Parameters:
value
- The weak to set.- Returns:
- This builder for chaining.
-
clearWeak
For Google-internal migration only. Do not use.
optional bool weak = 10 [default = false];
- Returns:
- This builder for chaining.
-
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
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.- Returns:
- This builder for chaining.
-
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];
- Returns:
- This builder for chaining.
-
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
public DescriptorProtos.FieldOptions.Builder setRetention(DescriptorProtos.FieldOptions.OptionRetention value) optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
- Parameters:
value
- The retention to set.- Returns:
- This builder for chaining.
-
clearRetention
optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
- Returns:
- This builder for chaining.
-
hasTarget
Deprecated.google.protobuf.FieldOptions.target is deprecated. See google/protobuf/descriptor.proto;l=713optional .google.protobuf.FieldOptions.OptionTargetType target = 18 [deprecated = true];
- Specified by:
hasTarget
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- Whether the target field is set.
-
getTarget
Deprecated.google.protobuf.FieldOptions.target is deprecated. See google/protobuf/descriptor.proto;l=713optional .google.protobuf.FieldOptions.OptionTargetType target = 18 [deprecated = true];
- Specified by:
getTarget
in interfaceDescriptorProtos.FieldOptionsOrBuilder
- Returns:
- The target.
-
setTarget
@Deprecated public DescriptorProtos.FieldOptions.Builder setTarget(DescriptorProtos.FieldOptions.OptionTargetType value) Deprecated.google.protobuf.FieldOptions.target is deprecated. See google/protobuf/descriptor.proto;l=713optional .google.protobuf.FieldOptions.OptionTargetType target = 18 [deprecated = true];
- Parameters:
value
- The target to set.- Returns:
- This builder for chaining.
-
clearTarget
Deprecated.google.protobuf.FieldOptions.target is deprecated. See google/protobuf/descriptor.proto;l=713optional .google.protobuf.FieldOptions.OptionTargetType target = 18 [deprecated = true];
- Returns:
- This builder for chaining.
-
ensureTargetsIsMutable
private void ensureTargetsIsMutable() -
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.
-
setTargets
public DescriptorProtos.FieldOptions.Builder setTargets(int index, DescriptorProtos.FieldOptions.OptionTargetType value) repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
- Parameters:
index
- The index to set the value at.value
- The targets to set.- Returns:
- This builder for chaining.
-
addTargets
public DescriptorProtos.FieldOptions.Builder addTargets(DescriptorProtos.FieldOptions.OptionTargetType value) repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
- Parameters:
value
- The targets to add.- Returns:
- This builder for chaining.
-
addAllTargets
public DescriptorProtos.FieldOptions.Builder addAllTargets(Iterable<? extends DescriptorProtos.FieldOptions.OptionTargetType> values) repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
- Parameters:
values
- The targets to add.- Returns:
- This builder for chaining.
-
clearTargets
repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
- Returns:
- This builder for chaining.
-
ensureUninterpretedOptionIsMutable
private void ensureUninterpretedOptionIsMutable() -
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
-
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
-
setUninterpretedOption
public DescriptorProtos.FieldOptions.Builder setUninterpretedOption(int index, DescriptorProtos.UninterpretedOption value) The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
setUninterpretedOption
public DescriptorProtos.FieldOptions.Builder setUninterpretedOption(int index, DescriptorProtos.UninterpretedOption.Builder builderForValue) The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
addUninterpretedOption
public DescriptorProtos.FieldOptions.Builder addUninterpretedOption(DescriptorProtos.UninterpretedOption value) The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
addUninterpretedOption
public DescriptorProtos.FieldOptions.Builder addUninterpretedOption(int index, DescriptorProtos.UninterpretedOption value) The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
addUninterpretedOption
public DescriptorProtos.FieldOptions.Builder addUninterpretedOption(DescriptorProtos.UninterpretedOption.Builder builderForValue) The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
addUninterpretedOption
public DescriptorProtos.FieldOptions.Builder addUninterpretedOption(int index, DescriptorProtos.UninterpretedOption.Builder builderForValue) The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
addAllUninterpretedOption
public DescriptorProtos.FieldOptions.Builder 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
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
removeUninterpretedOption
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
getUninterpretedOptionBuilder
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
getUninterpretedOptionOrBuilder
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
- Specified by:
getUninterpretedOptionOrBuilder
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;
- Specified by:
getUninterpretedOptionOrBuilderList
in interfaceDescriptorProtos.FieldOptionsOrBuilder
-
addUninterpretedOptionBuilder
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
addUninterpretedOptionBuilder
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
getUninterpretedOptionBuilderList
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
getUninterpretedOptionFieldBuilder
private RepeatedFieldBuilderV3<DescriptorProtos.UninterpretedOption,DescriptorProtos.UninterpretedOption.Builder, getUninterpretedOptionFieldBuilder()DescriptorProtos.UninterpretedOptionOrBuilder> -
setUnknownFields
Description copied from interface:Message.Builder
Set theUnknownFieldSet
for this message.- Specified by:
setUnknownFields
in interfaceMessage.Builder
- Overrides:
setUnknownFields
in classGeneratedMessageV3.Builder<DescriptorProtos.FieldOptions.Builder>
-
mergeUnknownFields
public final DescriptorProtos.FieldOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields) Description copied from interface:Message.Builder
Merge some unknown fields into theUnknownFieldSet
for this message.- Specified by:
mergeUnknownFields
in interfaceMessage.Builder
- Overrides:
mergeUnknownFields
in classGeneratedMessageV3.Builder<DescriptorProtos.FieldOptions.Builder>
-