-
public final class FieldOptionsKt.Dsl
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
FieldOptionsKt.Dsl.Companion
public final class
FieldOptionsKt.Dsl.UninterpretedOptionProxy
An uninstantiable, behaviorless type to represent the field in generics.
-
Field Summary
Fields Modifier and Type Field Description private DescriptorProtos.FieldOptions.CType
ctype
private Boolean
packed
private DescriptorProtos.FieldOptions.JSType
jstype
private Boolean
lazy
private Boolean
unverifiedLazy
private Boolean
deprecated
private Boolean
weak
private final DslList<DescriptorProtos.UninterpretedOption, FieldOptionsKt.Dsl.UninterpretedOptionProxy>
uninterpretedOption
-
Method Summary
Modifier and Type Method Description final DescriptorProtos.FieldOptions.CType
getCtype()
final Unit
setCtype(DescriptorProtos.FieldOptions.CType ctype)
final Boolean
getPacked()
final Unit
setPacked(Boolean packed)
final DescriptorProtos.FieldOptions.JSType
getJstype()
final Unit
setJstype(DescriptorProtos.FieldOptions.JSType jstype)
final Boolean
getLazy()
final Unit
setLazy(Boolean lazy)
final Boolean
getUnverifiedLazy()
final Unit
setUnverifiedLazy(Boolean unverifiedLazy)
final Boolean
getDeprecated()
final Unit
setDeprecated(Boolean deprecated)
final Boolean
getWeak()
final Unit
setWeak(Boolean weak)
final Unit
clearCtype()
<pre> The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. final Boolean
hasCtype()
<pre> The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. final Unit
clearPacked()
<pre> The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. final Boolean
hasPacked()
<pre> The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. final Unit
clearJstype()
<pre> The jstype option determines the JavaScript type used for values of the field. final Boolean
hasJstype()
<pre> The jstype option determines the JavaScript type used for values of the field. final Unit
clearLazy()
<pre> Should this field be parsed lazily? final Boolean
hasLazy()
<pre> Should this field be parsed lazily? final Unit
clearUnverifiedLazy()
<pre> unverified_lazy does no correctness checks on the byte stream. final Boolean
hasUnverifiedLazy()
<pre> unverified_lazy does no correctness checks on the byte stream. final Unit
clearDeprecated()
<pre> Is this field deprecated? final Boolean
hasDeprecated()
<pre> Is this field deprecated? final Unit
clearWeak()
<pre> For Google-internal migration only. final Boolean
hasWeak()
<pre> For Google-internal migration only. -
-
Method Detail
-
getCtype
final DescriptorProtos.FieldOptions.CType getCtype()
-
getJstype
final DescriptorProtos.FieldOptions.JSType getJstype()
-
getUnverifiedLazy
final Boolean getUnverifiedLazy()
-
setUnverifiedLazy
final Unit setUnverifiedLazy(Boolean unverifiedLazy)
-
getDeprecated
final Boolean getDeprecated()
-
setDeprecated
final Unit setDeprecated(Boolean deprecated)
-
clearCtype
final Unit clearCtype()
<pre> 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! </pre><code>optional .google.protobuf.FieldOptions.CType ctype = 1 default = STRING;</code>
-
hasCtype
final Boolean hasCtype()
<pre> 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! </pre><code>optional .google.protobuf.FieldOptions.CType ctype = 1 default = STRING;</code>
-
clearPacked
final Unit clearPacked()
<pre> 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. </pre><code>optional bool packed = 2;</code>
-
hasPacked
final Boolean hasPacked()
<pre> 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. </pre><code>optional bool packed = 2;</code>
-
clearJstype
final Unit clearJstype()
<pre> 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. </pre><code>optional .google.protobuf.FieldOptions.JSType jstype = 6 default = JS_NORMAL;</code>
-
hasJstype
final Boolean hasJstype()
<pre> 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. </pre><code>optional .google.protobuf.FieldOptions.JSType jstype = 6 default = JS_NORMAL;</code>
-
clearLazy
final Unit clearLazy()
<pre> 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 2021, lazy does no correctness checks on the byte stream during parsing. This may lead to crashes if and when an invalid byte stream is finally parsed upon access. TODO(b/211906113): Enable validation on lazy fields. </pre><code>optional bool lazy = 5 default = false;</code>
-
hasLazy
final Boolean hasLazy()
<pre> 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 2021, lazy does no correctness checks on the byte stream during parsing. This may lead to crashes if and when an invalid byte stream is finally parsed upon access. TODO(b/211906113): Enable validation on lazy fields. </pre><code>optional bool lazy = 5 default = false;</code>
-
clearUnverifiedLazy
final Unit clearUnverifiedLazy()
<pre> unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons. </pre><code>optional bool unverified_lazy = 15 default = false;</code>
-
hasUnverifiedLazy
final Boolean hasUnverifiedLazy()
<pre> unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons. </pre><code>optional bool unverified_lazy = 15 default = false;</code>
-
clearDeprecated
final Unit clearDeprecated()
<pre> 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. </pre><code>optional bool deprecated = 3 default = false;</code>
-
hasDeprecated
final Boolean hasDeprecated()
<pre> 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. </pre><code>optional bool deprecated = 3 default = false;</code>
-
clearWeak
final Unit clearWeak()
<pre> For Google-internal migration only. Do not use. </pre><code>optional bool weak = 10 default = false;</code>
-
-
-
-