Package com.google.protobuf

Class DescriptorProtos.FieldOptions

    • Constructor Detail

      • FieldOptions

        private FieldOptions()

    • Method Detail

      • hasCtype

        public boolean hasCtype()
         NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead.
 The ctype option instructs the C++ code generator to use a different
 representation of the field than it normally would.  See the specific
 options below.  This option is only implemented to support use of
 [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
 type "bytes" in the open source release.
 TODO: make ctype actually deprecated.
        optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
        Specified by:
        hasCtype in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        Whether the ctype field is set.

      • getCtype

        public DescriptorProtos.FieldOptions.CType getCtype()
         NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead.
 The ctype option instructs the C++ code generator to use a different
 representation of the field than it normally would.  See the specific
 options below.  This option is only implemented to support use of
 [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
 type "bytes" in the open source release.
 TODO: make ctype actually deprecated.
        optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
        Specified by:
        getCtype in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The ctype.

      • setCtype

        private void setCtype​(DescriptorProtos.FieldOptions.CType value)
         NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead.
 The ctype option instructs the C++ code generator to use a different
 representation of the field than it normally would.  See the specific
 options below.  This option is only implemented to support use of
 [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
 type "bytes" in the open source release.
 TODO: make ctype actually deprecated.
        optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
        Parameters:
        value - The ctype to set.

      • clearCtype

        private void clearCtype()
         NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead.
 The ctype option instructs the C++ code generator to use a different
 representation of the field than it normally would.  See the specific
 options below.  This option is only implemented to support use of
 [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
 type "bytes" in the open source release.
 TODO: make ctype actually deprecated.
        optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];

      • hasPacked

        public boolean hasPacked()
         The packed option can be enabled for repeated primitive fields to enable
 a more efficient representation on the wire. Rather than repeatedly
 writing the tag and type for each element, the entire array is encoded as
 a single length-delimited blob. In proto3, only explicit setting it to
 false will avoid using packed encoding.  This option is prohibited in
 Editions, but the `repeated_field_encoding` feature can be used to control
 the behavior.
        optional bool packed = 2;
        Specified by:
        hasPacked in 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.  This option is prohibited in
 Editions, but the `repeated_field_encoding` feature can be used to control
 the behavior.
        optional bool packed = 2;
        Specified by:
        getPacked in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The packed.

      • setPacked

        private void setPacked​(boolean value)
         The packed option can be enabled for repeated primitive fields to enable
 a more efficient representation on the wire. Rather than repeatedly
 writing the tag and type for each element, the entire array is encoded as
 a single length-delimited blob. In proto3, only explicit setting it to
 false will avoid using packed encoding.  This option is prohibited in
 Editions, but the `repeated_field_encoding` feature can be used to control
 the behavior.
        optional bool packed = 2;
        Parameters:
        value - The packed to set.

      • clearPacked

        private void clearPacked()
         The packed option can be enabled for repeated primitive fields to enable
 a more efficient representation on the wire. Rather than repeatedly
 writing the tag and type for each element, the entire array is encoded as
 a single length-delimited blob. In proto3, only explicit setting it to
 false will avoid using packed encoding.  This option is prohibited in
 Editions, but the `repeated_field_encoding` feature can be used to control
 the behavior.
        optional bool packed = 2;

      • hasJstype

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

 This option is an enum to permit additional types to be added, e.g.
 goog.math.Integer.
        optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];
        Specified by:
        hasJstype in 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

        private void 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.

      • clearJstype

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

 This option is an enum to permit additional types to be added, e.g.
 goog.math.Integer.
        optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];

      • hasLazy

        public boolean hasLazy()
         Should this field be parsed lazily?  Lazy applies only to message-type
 fields.  It means that when the outer message is initially parsed, the
 inner message's contents will not be parsed but instead stored in encoded
 form.  The inner message will actually be parsed when it is first accessed.

 This is only a hint.  Implementations are free to choose whether to use
 eager or lazy parsing regardless of the value of this option.  However,
 setting this option true suggests that the protocol author believes that
 using lazy parsing on this field is worth the additional bookkeeping
 overhead typically needed to implement it.

 This option does not affect the public interface of any generated code;
 all method signatures remain the same.  Furthermore, thread-safety of the
 interface is not affected by this option; const methods remain safe to
 call from multiple threads concurrently, while non-const methods continue
 to require exclusive access.

 Note that lazy message fields are still eagerly verified to check
 ill-formed wireformat or missing required fields. Calling IsInitialized()
 on the outer message would fail if the inner message has missing required
 fields. Failed verification would result in parsing failure (except when
 uninitialized messages are acceptable).
        optional bool lazy = 5 [default = false];
        Specified by:
        hasLazy in 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 lazy message fields are still eagerly verified to check
 ill-formed wireformat or missing required fields. Calling IsInitialized()
 on the outer message would fail if the inner message has missing required
 fields. Failed verification would result in parsing failure (except when
 uninitialized messages are acceptable).
        optional bool lazy = 5 [default = false];
        Specified by:
        getLazy in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The lazy.

      • setLazy

        private void setLazy​(boolean value)
         Should this field be parsed lazily?  Lazy applies only to message-type
 fields.  It means that when the outer message is initially parsed, the
 inner message's contents will not be parsed but instead stored in encoded
 form.  The inner message will actually be parsed when it is first accessed.

 This is only a hint.  Implementations are free to choose whether to use
 eager or lazy parsing regardless of the value of this option.  However,
 setting this option true suggests that the protocol author believes that
 using lazy parsing on this field is worth the additional bookkeeping
 overhead typically needed to implement it.

 This option does not affect the public interface of any generated code;
 all method signatures remain the same.  Furthermore, thread-safety of the
 interface is not affected by this option; const methods remain safe to
 call from multiple threads concurrently, while non-const methods continue
 to require exclusive access.

 Note that lazy message fields are still eagerly verified to check
 ill-formed wireformat or missing required fields. Calling IsInitialized()
 on the outer message would fail if the inner message has missing required
 fields. Failed verification would result in parsing failure (except when
 uninitialized messages are acceptable).
        optional bool lazy = 5 [default = false];
        Parameters:
        value - The lazy to set.

      • clearLazy

        private void clearLazy()
         Should this field be parsed lazily?  Lazy applies only to message-type
 fields.  It means that when the outer message is initially parsed, the
 inner message's contents will not be parsed but instead stored in encoded
 form.  The inner message will actually be parsed when it is first accessed.

 This is only a hint.  Implementations are free to choose whether to use
 eager or lazy parsing regardless of the value of this option.  However,
 setting this option true suggests that the protocol author believes that
 using lazy parsing on this field is worth the additional bookkeeping
 overhead typically needed to implement it.

 This option does not affect the public interface of any generated code;
 all method signatures remain the same.  Furthermore, thread-safety of the
 interface is not affected by this option; const methods remain safe to
 call from multiple threads concurrently, while non-const methods continue
 to require exclusive access.

 Note that lazy message fields are still eagerly verified to check
 ill-formed wireformat or missing required fields. Calling IsInitialized()
 on the outer message would fail if the inner message has missing required
 fields. Failed verification would result in parsing failure (except when
 uninitialized messages are acceptable).
        optional bool lazy = 5 [default = false];

      • hasUnverifiedLazy

        public boolean hasUnverifiedLazy()
         unverified_lazy does no correctness checks on the byte stream. This should
 only be used where lazy with verification is prohibitive for performance
 reasons.
        optional bool unverified_lazy = 15 [default = false];
        Specified by:
        hasUnverifiedLazy in 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

        private void setUnverifiedLazy​(boolean value)
         unverified_lazy does no correctness checks on the byte stream. This should
 only be used where lazy with verification is prohibitive for performance
 reasons.
        optional bool unverified_lazy = 15 [default = false];
        Parameters:
        value - The unverifiedLazy to set.

      • clearUnverifiedLazy

        private void clearUnverifiedLazy()
         unverified_lazy does no correctness checks on the byte stream. This should
 only be used where lazy with verification is prohibitive for performance
 reasons.
        optional bool unverified_lazy = 15 [default = false];

      • hasDeprecated

        public boolean hasDeprecated()
         Is this field deprecated?
 Depending on the target platform, this can emit Deprecated annotations
 for accessors, or it will be completely ignored; in the very least, this
 is a formalization for deprecating fields.
        optional bool deprecated = 3 [default = false];
        Specified by:
        hasDeprecated in 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

        private void setDeprecated​(boolean value)
         Is this field deprecated?
 Depending on the target platform, this can emit Deprecated annotations
 for accessors, or it will be completely ignored; in the very least, this
 is a formalization for deprecating fields.
        optional bool deprecated = 3 [default = false];
        Parameters:
        value - The deprecated to set.

      • clearDeprecated

        private void clearDeprecated()
         Is this field deprecated?
 Depending on the target platform, this can emit Deprecated annotations
 for accessors, or it will be completely ignored; in the very least, this
 is a formalization for deprecating fields.
        optional bool deprecated = 3 [default = false];

      • hasWeak

        public boolean hasWeak()
         For Google-internal migration only. Do not use.
        optional bool weak = 10 [default = false];
        Specified by:
        hasWeak in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        Whether the weak field is set.

      • setWeak

        private void setWeak​(boolean value)
         For Google-internal migration only. Do not use.
        optional bool weak = 10 [default = false];
        Parameters:
        value - The weak to set.

      • clearWeak

        private void clearWeak()
         For Google-internal migration only. Do not use.
        optional bool weak = 10 [default = false];

      • hasDebugRedact

        public boolean hasDebugRedact()
         Indicate that the field value should not be printed out when using debug
 formats, e.g. when the field contains sensitive credentials.
        optional bool debug_redact = 16 [default = false];
        Specified by:
        hasDebugRedact in 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

        private void setDebugRedact​(boolean value)
         Indicate that the field value should not be printed out when using debug
 formats, e.g. when the field contains sensitive credentials.
        optional bool debug_redact = 16 [default = false];
        Parameters:
        value - The debugRedact to set.

      • clearDebugRedact

        private void clearDebugRedact()
         Indicate that the field value should not be printed out when using debug
 formats, e.g. when the field contains sensitive credentials.
        optional bool debug_redact = 16 [default = false];

      • clearRetention

        private void clearRetention()
        optional .google.protobuf.FieldOptions.OptionRetention retention = 17;

      • ensureTargetsIsMutable

        private void ensureTargetsIsMutable()

      • setTargets

        private void 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.

      • addAllTargets

        private void addAllTargets​(java.lang.Iterable<? extends DescriptorProtos.FieldOptions.OptionTargetType> values)
        repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
        Parameters:
        values - The targets to add.

      • clearTargets

        private void clearTargets()
        repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;

      • ensureEditionDefaultsIsMutable

        private void ensureEditionDefaultsIsMutable()

      • addAllEditionDefaults

        private void addAllEditionDefaults​(java.lang.Iterable<? extends DescriptorProtos.FieldOptions.EditionDefault> values)
        repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

      • clearEditionDefaults

        private void clearEditionDefaults()
        repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

      • removeEditionDefaults

        private void removeEditionDefaults​(int index)
        repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

      • hasFeatures

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

      • setFeatures

        private void setFeatures​(DescriptorProtos.FeatureSet value)
         Any features defined in the specific edition.
        optional .google.protobuf.FeatureSet features = 21;

      • mergeFeatures

        private void mergeFeatures​(DescriptorProtos.FeatureSet value)
         Any features defined in the specific edition.
        optional .google.protobuf.FeatureSet features = 21;

      • clearFeatures

        private void clearFeatures()
         Any features defined in the specific edition.
        optional .google.protobuf.FeatureSet features = 21;

      • clearFeatureSupport

        private void clearFeatureSupport()
        optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;

      • getUninterpretedOptionOrBuilderList

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

      • getUninterpretedOptionOrBuilder

        public DescriptorProtos.UninterpretedOptionOrBuilder getUninterpretedOptionOrBuilder​(int index)
         The parser stores options it doesn't recognize here. See above.
        repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

      • ensureUninterpretedOptionIsMutable

        private void ensureUninterpretedOptionIsMutable()

      • setUninterpretedOption

        private void setUninterpretedOption​(int index,
                                    DescriptorProtos.UninterpretedOption value)
         The parser stores options it doesn't recognize here. See above.
        repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

      • addUninterpretedOption

        private void addUninterpretedOption​(DescriptorProtos.UninterpretedOption value)
         The parser stores options it doesn't recognize here. See above.
        repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

      • addUninterpretedOption

        private void addUninterpretedOption​(int index,
                                    DescriptorProtos.UninterpretedOption value)
         The parser stores options it doesn't recognize here. See above.
        repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

      • addAllUninterpretedOption

        private void addAllUninterpretedOption​(java.lang.Iterable<? extends DescriptorProtos.UninterpretedOption> values)
         The parser stores options it doesn't recognize here. See above.
        repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

      • clearUninterpretedOption

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

      • removeUninterpretedOption

        private void removeUninterpretedOption​(int index)
         The parser stores options it doesn't recognize here. See above.
        repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

      • parseFrom

        public static DescriptorProtos.FieldOptions parseFrom​(java.io.InputStream input)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static DescriptorProtos.FieldOptions parseDelimitedFrom​(java.io.InputStream input)
                                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • dynamicMethod

        protected final java.lang.Object dynamicMethod​(GeneratedMessageLite.MethodToInvoke method,
                                               java.lang.Object arg0,
                                               java.lang.Object arg1)
        Description copied from class: GeneratedMessageLite
        A method that implements different types of operations described in GeneratedMessageLite.MethodToInvoke. These different kinds of operations are required to implement message-level operations for builders in the runtime. This method bundles those operations to reduce the generated methods count.
        • NEW_INSTANCE returns a new instance of the protocol buffer that has not yet been made immutable. See MAKE_IMMUTABLE.
        • IS_INITIALIZED returns null for false and the default instance for true. It doesn't use or modify any memoized value.
        • GET_MEMOIZED_IS_INITIALIZED returns the memoized isInitialized byte value.
        • SET_MEMOIZED_IS_INITIALIZED sets the memoized isInitialized byte value to 1 if the first parameter is not null, or to 0 if the first parameter is null.
        • NEW_BUILDER returns a BuilderType instance.
        This method, plus the implementation of the Builder, enables the Builder class to be proguarded away entirely on Android.

        For use by generated code only.

        Specified by:
        dynamicMethod in class GeneratedMessageLite<DescriptorProtos.FieldOptions,​DescriptorProtos.FieldOptions.Builder>