Package com.google.protobuf

Class DescriptorProtos.FieldOptions.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<DescriptorProtos.FieldOptions.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DescriptorProtos.FieldOptions.Builder>

      • getDefaultInstanceForType

        public DescriptorProtos.FieldOptions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public DescriptorProtos.FieldOptions build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public DescriptorProtos.FieldOptions buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • mergeFrom

        public DescriptorProtos.FieldOptions.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DescriptorProtos.FieldOptions.Builder>
        Throws:
        java.io.IOException

      • 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 interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        Whether the ctype field is set.

      • 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 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 interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The ctype.

      • setCtype

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

        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 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 interface DescriptorProtos.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 interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The packed.

      • setPacked

        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;
        Parameters:
        value - The packed to set.
        Returns:
        This builder for chaining.

      • 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:
        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 interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        Whether the jstype field is set.

      • 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];
        Specified by:
        getJstype in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The jstype.

      • setJstype

        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];
        Parameters:
        value - The jstype to set.
        Returns:
        This builder for chaining.

      • 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:
        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 interface DescriptorProtos.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 interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The lazy.

      • setLazy

        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.

 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

        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.

 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 interface DescriptorProtos.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 interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The unverifiedLazy.

      • setUnverifiedLazy

        public DescriptorProtos.FieldOptions.Builder 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.
        Returns:
        This builder for chaining.

      • clearUnverifiedLazy

        public DescriptorProtos.FieldOptions.Builder 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 interface DescriptorProtos.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 interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The deprecated.

      • setDeprecated

        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];
        Parameters:
        value - The deprecated to set.
        Returns:
        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:
        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 interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        Whether the weak field is set.

      • setWeak

        public DescriptorProtos.FieldOptions.Builder setWeak​(boolean value)
         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

        public DescriptorProtos.FieldOptions.Builder 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 interface DescriptorProtos.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 interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The debugRedact.

      • setDebugRedact

        public DescriptorProtos.FieldOptions.Builder 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.
        Returns:
        This builder for chaining.

      • clearDebugRedact

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

      • clearRetention

        public DescriptorProtos.FieldOptions.Builder clearRetention()
        optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
        Returns:
        This builder for chaining.

      • hasFeatures

        public boolean hasFeatures()
         Any features defined in the specific edition.
        optional .google.protobuf.FeatureSet features = 21;
        Specified by:
        hasFeatures in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        Whether the features field is set.

      • getFeaturesBuilder

        public DescriptorProtos.FeatureSet.Builder getFeaturesBuilder()
         Any features defined in the specific edition.
        optional .google.protobuf.FeatureSet features = 21;

      • clearUninterpretedOption

        public DescriptorProtos.FieldOptions.Builder clearUninterpretedOption()
         The parser stores options it doesn't recognize here. See above.
        repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

      • removeUninterpretedOption

        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;

      • getUninterpretedOptionBuilder

        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;

      • addUninterpretedOptionBuilder

        public DescriptorProtos.UninterpretedOption.Builder addUninterpretedOptionBuilder()
         The parser stores options it doesn't recognize here. See above.
        repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

      • addUninterpretedOptionBuilder

        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;

      • getUninterpretedOptionBuilderList

        public java.util.List<DescriptorProtos.UninterpretedOption.Builder> getUninterpretedOptionBuilderList()
         The parser stores options it doesn't recognize here. See above.
        repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;