Class DescriptorProtos.FieldOptions.Builder

public static final class DescriptorProtos.FieldOptions.Builder extends GeneratedMessageV3.ExtendableBuilder<DescriptorProtos.FieldOptions,DescriptorProtos.FieldOptions.Builder> implements DescriptorProtos.FieldOptionsOrBuilder

Protobuf type google.protobuf.FieldOptions

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptors.Descriptor

Methods

<Type>addExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions,List<Type>> extension, Type value)

public DescriptorProtos.FieldOptions.Builder <Type>addExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions,List<Type>> extension, Type value)

Append a value to a repeated extension.

Parameters
NameDescription
extensionGeneratedExtension<FieldOptions,List<Type>>
valueType
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

<Type>clearExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions,?> extension)

public DescriptorProtos.FieldOptions.Builder <Type>clearExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions,?> extension)

Clear an extension.

Parameter
NameDescription
extensionGeneratedExtension<FieldOptions,?>
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

<Type>setExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions,Type> extension, Type value)

public DescriptorProtos.FieldOptions.Builder <Type>setExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions,Type> extension, Type value)

Set the value of an extension.

Parameters
NameDescription
extensionGeneratedExtension<FieldOptions,Type>
valueType
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

<Type>setExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions,List<Type>> extension, int index, Type value)

public DescriptorProtos.FieldOptions.Builder <Type>setExtension(GeneratedMessage.GeneratedExtension<DescriptorProtos.FieldOptions,List<Type>> extension, int index, Type value)

Set the value of one element of a repeated extension.

Parameters
NameDescription
extensionGeneratedExtension<FieldOptions,List<Type>>
indexint
valueType
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

addAllUninterpretedOption(Iterable<? extends DescriptorProtos.UninterpretedOption> values)

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;

Parameter
NameDescription
valuesIterable<? extends com.google.protobuf.DescriptorProtos.UninterpretedOption>
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DescriptorProtos.FieldOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldDescriptors.FieldDescriptor
valueObject
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

addUninterpretedOption(DescriptorProtos.UninterpretedOption value)

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;

Parameter
NameDescription
valueDescriptorProtos.UninterpretedOption
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

addUninterpretedOption(DescriptorProtos.UninterpretedOption.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueDescriptorProtos.UninterpretedOption.Builder
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

addUninterpretedOption(int index, DescriptorProtos.UninterpretedOption value)

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;

Parameters
NameDescription
indexint
valueDescriptorProtos.UninterpretedOption
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

addUninterpretedOption(int index, DescriptorProtos.UninterpretedOption.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueDescriptorProtos.UninterpretedOption.Builder
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

addUninterpretedOptionBuilder()

public DescriptorProtos.UninterpretedOption.Builder addUninterpretedOptionBuilder()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
TypeDescription
DescriptorProtos.UninterpretedOption.Builder

addUninterpretedOptionBuilder(int index)

public DescriptorProtos.UninterpretedOption.Builder addUninterpretedOptionBuilder(int index)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.UninterpretedOption.Builder

build()

public DescriptorProtos.FieldOptions build()
Returns
TypeDescription
DescriptorProtos.FieldOptions

buildPartial()

public DescriptorProtos.FieldOptions buildPartial()
Returns
TypeDescription
DescriptorProtos.FieldOptions

clear()

public DescriptorProtos.FieldOptions.Builder clear()

Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.

Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

clearCtype()

public DescriptorProtos.FieldOptions.Builder 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 not yet implemented in the open source release -- sorry, we'll try to include it in a future version!

optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];

Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

This builder for chaining.

clearDeprecated()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DescriptorProtos.FieldOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldDescriptors.FieldDescriptor
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

clearJstype()

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

This builder for chaining.

clearLazy()

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

optional bool lazy = 5 [default = false];

Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DescriptorProtos.FieldOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)

TODO(jieluo): Clear it when all subclasses have implemented this method.

Parameter
NameDescription
oneofDescriptors.OneofDescriptor
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

clearPacked()

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

This builder for chaining.

clearUninterpretedOption()

public DescriptorProtos.FieldOptions.Builder clearUninterpretedOption()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

clearWeak()

public DescriptorProtos.FieldOptions.Builder clearWeak()

For Google-internal migration only. Do not use.

optional bool weak = 10 [default = false];

Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

This builder for chaining.

clone()

public DescriptorProtos.FieldOptions.Builder clone()

Clones the Builder.

Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

getCtype()

public DescriptorProtos.FieldOptions.CType getCtype()

The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is not yet implemented in the open source release -- sorry, we'll try to include it in a future version!

optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];

Returns
TypeDescription
DescriptorProtos.FieldOptions.CType

The ctype.

getDefaultInstanceForType()

public DescriptorProtos.FieldOptions getDefaultInstanceForType()

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Returns
TypeDescription
DescriptorProtos.FieldOptions

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];

Returns
TypeDescription
boolean

The deprecated.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Get the message's type's descriptor. This differs from the getDescriptor() method of generated message classes in that this method is an abstract method of the Message interface whereas getDescriptor() is a static method of a specific class. They return the same thing.

Returns
TypeDescription
Descriptors.Descriptor
Overrides

getJstype()

public DescriptorProtos.FieldOptions.JSType getJstype()

The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent. This option is an enum to permit additional types to be added, e.g. goog.math.Integer.

optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];

Returns
TypeDescription
DescriptorProtos.FieldOptions.JSType

The jstype.

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.

optional bool lazy = 5 [default = false];

Returns
TypeDescription
boolean

The lazy.

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;

Returns
TypeDescription
boolean

The packed.

getUninterpretedOption(int index)

public DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.UninterpretedOption

getUninterpretedOptionBuilder(int index)

public DescriptorProtos.UninterpretedOption.Builder getUninterpretedOptionBuilder(int index)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.UninterpretedOption.Builder

getUninterpretedOptionBuilderList()

public List<DescriptorProtos.UninterpretedOption.Builder> getUninterpretedOptionBuilderList()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
TypeDescription
List<Builder>

getUninterpretedOptionCount()

public int getUninterpretedOptionCount()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
TypeDescription
int

getUninterpretedOptionList()

public List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Returns
TypeDescription
List<UninterpretedOption>

getUninterpretedOptionOrBuilder(int index)

public DescriptorProtos.UninterpretedOptionOrBuilder getUninterpretedOptionOrBuilder(int index)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.UninterpretedOptionOrBuilder

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;

Returns
TypeDescription
List<? extends com.google.protobuf.DescriptorProtos.UninterpretedOptionOrBuilder>

getWeak()

public boolean getWeak()

For Google-internal migration only. Do not use.

optional bool weak = 10 [default = false];

Returns
TypeDescription
boolean

The weak.

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 not yet implemented in the open source release -- sorry, we'll try to include it in a future version!

optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];

Returns
TypeDescription
boolean

Whether the ctype field is set.

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];

Returns
TypeDescription
boolean

Whether the deprecated field is set.

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];

Returns
TypeDescription
boolean

Whether the jstype field is set.

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.

optional bool lazy = 5 [default = false];

Returns
TypeDescription
boolean

Whether the lazy field is set.

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;

Returns
TypeDescription
boolean

Whether the packed field is set.

hasWeak()

public boolean hasWeak()

For Google-internal migration only. Do not use.

optional bool weak = 10 [default = false];

Returns
TypeDescription
boolean

Whether the weak field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

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.

Returns
TypeDescription
GeneratedMessageV3.FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder#getInitializationErrorString()

Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DescriptorProtos.FieldOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Like Builder#mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.

Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(DescriptorProtos.FieldOptions other)

public DescriptorProtos.FieldOptions.Builder mergeFrom(DescriptorProtos.FieldOptions other)
Parameter
NameDescription
otherDescriptorProtos.FieldOptions
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

mergeFrom(Message other)

public DescriptorProtos.FieldOptions.Builder mergeFrom(Message other)

Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()).

Merging occurs as follows. For each field:

  • For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
  • For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
  • For repeated fields, the elements in other 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++.

Parameter
NameDescription
otherMessage
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DescriptorProtos.FieldOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Merge some unknown fields into the UnknownFieldSet for this message.

Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

removeUninterpretedOption(int index)

public DescriptorProtos.FieldOptions.Builder removeUninterpretedOption(int index)

The parser stores options it doesn't recognize here. See above.

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Parameter
NameDescription
indexint
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

setCtype(DescriptorProtos.FieldOptions.CType value)

public DescriptorProtos.FieldOptions.Builder setCtype(DescriptorProtos.FieldOptions.CType value)

The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is not yet implemented in the open source release -- sorry, we'll try to include it in a future version!

optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];

Parameter
NameDescription
valueDescriptorProtos.FieldOptions.CType

The ctype to set.

Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

This builder for chaining.

setDeprecated(boolean value)

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

Parameter
NameDescription
valueboolean

The deprecated to set.

Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DescriptorProtos.FieldOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldDescriptors.FieldDescriptor
valueObject
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

setJstype(DescriptorProtos.FieldOptions.JSType value)

public DescriptorProtos.FieldOptions.Builder setJstype(DescriptorProtos.FieldOptions.JSType value)

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];

Parameter
NameDescription
valueDescriptorProtos.FieldOptions.JSType

The jstype to set.

Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

This builder for chaining.

setLazy(boolean value)

public DescriptorProtos.FieldOptions.Builder 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 implementations may choose not to check required fields within a lazy sub-message. That is, calling IsInitialized() on the outer message may return true even if the inner message has missing required fields. This is necessary because otherwise the inner message would have to be parsed in order to perform the check, defeating the purpose of lazy parsing. An implementation which chooses not to check required fields must be consistent about it. That is, for any particular sub-message, the implementation must either always check its required fields, or never check its required fields, regardless of whether or not the message has been parsed.

optional bool lazy = 5 [default = false];

Parameter
NameDescription
valueboolean

The lazy to set.

Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

This builder for chaining.

setPacked(boolean value)

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

optional bool packed = 2;

Parameter
NameDescription
valueboolean

The packed to set.

Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DescriptorProtos.FieldOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldDescriptors.FieldDescriptor
indexint
valueObject
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

setUninterpretedOption(int index, DescriptorProtos.UninterpretedOption value)

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;

Parameters
NameDescription
indexint
valueDescriptorProtos.UninterpretedOption
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

setUninterpretedOption(int index, DescriptorProtos.UninterpretedOption.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueDescriptorProtos.UninterpretedOption.Builder
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final DescriptorProtos.FieldOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder
Overrides

setWeak(boolean value)

public DescriptorProtos.FieldOptions.Builder setWeak(boolean value)

For Google-internal migration only. Do not use.

optional bool weak = 10 [default = false];

Parameter
NameDescription
valueboolean

The weak to set.

Returns
TypeDescription
DescriptorProtos.FieldOptions.Builder

This builder for chaining.