Interface DescriptorProtos.FieldOptionsOrBuilder

public static interface DescriptorProtos.FieldOptionsOrBuilder extends GeneratedMessageV3.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>

Implements

com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<com.google.protobuf.DescriptorProtos.FieldOptions>

Methods

getCtype()

public abstract 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.

getDeprecated()

public abstract 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.

getJstype()

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

getUninterpretedOptionCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean getWeak()


For Google-internal migration only. Do not use.

optional bool weak = 10 [default = false];

Returns
TypeDescription
boolean

The weak.

hasCtype()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.