Class DescriptorProtos.FieldOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableMessage<DescriptorProtos.FieldOptions>

com.google.protobuf.DescriptorProtos.FieldOptions

All Implemented Interfaces:

DescriptorProtos.FieldOptionsOrBuilder, GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

Enclosing class:

DescriptorProtos

public static final class DescriptorProtos.FieldOptions
extends GeneratedMessage.ExtendableMessage<DescriptorProtos.FieldOptions>
implements DescriptorProtos.FieldOptionsOrBuilder

Protobuf type google.protobuf.FieldOptions

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DescriptorProtos.FieldOptions.Builder	Protobuf type google.protobuf.FieldOptions
static enum	DescriptorProtos.FieldOptions.CType	Protobuf enum google.protobuf.FieldOptions.CType
static final class	DescriptorProtos.FieldOptions.EditionDefault	Protobuf type google.protobuf.FieldOptions.EditionDefault
static interface	DescriptorProtos.FieldOptions.EditionDefaultOrBuilder
static final class	DescriptorProtos.FieldOptions.FeatureSupport	Information about the support window of a feature.
static interface	DescriptorProtos.FieldOptions.FeatureSupportOrBuilder
static enum	DescriptorProtos.FieldOptions.JSType	Protobuf enum google.protobuf.FieldOptions.JSType
static enum	DescriptorProtos.FieldOptions.OptionRetention	If set to RETENTION_SOURCE, the option will be omitted from the binary.
static enum	DescriptorProtos.FieldOptions.OptionTargetType	This indicates the types of entities that the field may apply to when used as an option.

Nested classes/interfaces inherited from class GeneratedMessage.ExtendableMessage

GeneratedMessage.ExtendableMessage.ExtensionSerializer, GeneratedMessage.ExtendableMessage.ExtensionWriter, GeneratedMessage.ExtendableMessage.FieldEntry

Nested classes/interfaces inherited from class GeneratedMessage

GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, GeneratedMessage.ExtendableMessage<MessageT>, GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, GeneratedMessage.ExtensionDescriptorRetriever, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingT, T>, GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessage

AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
private int	bitField0_
private int	ctype_
static final int	CTYPE_FIELD_NUMBER
static final int	DEBUG_REDACT_FIELD_NUMBER
private boolean	debugRedact_
private static final DescriptorProtos.FieldOptions	DEFAULT_INSTANCE
private boolean	deprecated_
static final int	DEPRECATED_FIELD_NUMBER
static final int	EDITION_DEFAULTS_FIELD_NUMBER
private List<DescriptorProtos.FieldOptions.EditionDefault>	editionDefaults_
static final int	FEATURE_SUPPORT_FIELD_NUMBER
private DescriptorProtos.FeatureSet	features_
static final int	FEATURES_FIELD_NUMBER
private DescriptorProtos.FieldOptions.FeatureSupport	featureSupport_
private int	jstype_
static final int	JSTYPE_FIELD_NUMBER
private boolean	lazy_
static final int	LAZY_FIELD_NUMBER
private byte	memoizedIsInitialized
private boolean	packed_
static final int	PACKED_FIELD_NUMBER
private static final Parser<DescriptorProtos.FieldOptions>	PARSER
private int	retention_
static final int	RETENTION_FIELD_NUMBER
private static final long	serialVersionUID
private Internal.IntList	targets_
private static final Internal.IntListAdapter.IntConverter<DescriptorProtos.FieldOptions.OptionTargetType>	targets_converter_
static final int	TARGETS_FIELD_NUMBER
static final int	UNINTERPRETED_OPTION_FIELD_NUMBER
private List<DescriptorProtos.UninterpretedOption>	uninterpretedOption_
static final int	UNVERIFIED_LAZY_FIELD_NUMBER
private boolean	unverifiedLazy_
private boolean	weak_
static final int	WEAK_FIELD_NUMBER

Fields inherited from class GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, PRE22_GENCODE_ERROR_PROPERTY, PRE22_GENCODE_SILENCE_PROPERTY, PRE22_GENCODE_VULNERABILITY_MESSAGE, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FieldOptions()
private	FieldOptions(GeneratedMessage.ExtendableBuilder<DescriptorProtos.FieldOptions, ?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Compares the specified object with this message for equality.
DescriptorProtos.FieldOptions.CType	getCtype()	NOTE: ctype is deprecated.
boolean	getDebugRedact()	Indicate that the field value should not be printed out when using debug formats, e.g.
static DescriptorProtos.FieldOptions	getDefaultInstance()
DescriptorProtos.FieldOptions	getDefaultInstanceForType()	Get an instance of the type with no fields set.
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.
static final Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()	Get the message's type's descriptor.
DescriptorProtos.FieldOptions.EditionDefault	getEditionDefaults(int index)	repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
int	getEditionDefaultsCount()	repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
List<DescriptorProtos.FieldOptions.EditionDefault>	getEditionDefaultsList()	repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
DescriptorProtos.FieldOptions.EditionDefaultOrBuilder	getEditionDefaultsOrBuilder(int index)	repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
List<? extends DescriptorProtos.FieldOptions.EditionDefaultOrBuilder>	getEditionDefaultsOrBuilderList()	repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;
DescriptorProtos.FeatureSet	getFeatures()	Any features defined in the specific edition.
DescriptorProtos.FeatureSetOrBuilder	getFeaturesOrBuilder()	Any features defined in the specific edition.
DescriptorProtos.FieldOptions.FeatureSupport	getFeatureSupport()	optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
DescriptorProtos.FieldOptions.FeatureSupportOrBuilder	getFeatureSupportOrBuilder()	optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
DescriptorProtos.FieldOptions.JSType	getJstype()	The jstype option determines the JavaScript type used for values of the field.
boolean	getLazy()	Should this field be parsed lazily? Lazy applies only to message-type fields.
boolean	getPacked()	The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.
Parser<DescriptorProtos.FieldOptions>	getParserForType()	TODO: Remove this unnecessary intermediate implementation of this method.
DescriptorProtos.FieldOptions.OptionRetention	getRetention()	optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
int	getSerializedSize()	Get the number of bytes required to encode this message.
DescriptorProtos.FieldOptions.OptionTargetType	getTargets(int index)	repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
int	getTargetsCount()	repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
List<DescriptorProtos.FieldOptions.OptionTargetType>	getTargetsList()	repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
DescriptorProtos.UninterpretedOption	getUninterpretedOption(int index)	The parser stores options it doesn't recognize here.
int	getUninterpretedOptionCount()	The parser stores options it doesn't recognize here.
List<DescriptorProtos.UninterpretedOption>	getUninterpretedOptionList()	The parser stores options it doesn't recognize here.
DescriptorProtos.UninterpretedOptionOrBuilder	getUninterpretedOptionOrBuilder(int index)	The parser stores options it doesn't recognize here.
List<? extends DescriptorProtos.UninterpretedOptionOrBuilder>	getUninterpretedOptionOrBuilderList()	The parser stores options it doesn't recognize here.
boolean	getUnverifiedLazy()	unverified_lazy does no correctness checks on the byte stream.
boolean	getWeak()	Deprecated. google.protobuf.FieldOptions.weak is deprecated.
boolean	hasCtype()	NOTE: ctype is deprecated.
boolean	hasDebugRedact()	Indicate that the field value should not be printed out when using debug formats, e.g.
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.
boolean	hasFeatures()	Any features defined in the specific edition.
boolean	hasFeatureSupport()	optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
int	hashCode()	Returns the hash code value for this message.
boolean	hasJstype()	The jstype option determines the JavaScript type used for values of the field.
boolean	hasLazy()	Should this field be parsed lazily? Lazy applies only to message-type fields.
boolean	hasPacked()	The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.
boolean	hasRetention()	optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
boolean	hasUnverifiedLazy()	unverified_lazy does no correctness checks on the byte stream.
boolean	hasWeak()	Deprecated. google.protobuf.FieldOptions.weak is deprecated.
protected GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
final boolean	isInitialized()	Returns true if all required fields in the message and all embedded messages are set, false otherwise.
static DescriptorProtos.FieldOptions.Builder	newBuilder()
static DescriptorProtos.FieldOptions.Builder	newBuilder(DescriptorProtos.FieldOptions prototype)
DescriptorProtos.FieldOptions.Builder	newBuilderForType()	Constructs a new builder for a message of the same type as this message.
protected DescriptorProtos.FieldOptions.Builder	newBuilderForType(AbstractMessage.BuilderParent parent)	Create a nested builder.
static DescriptorProtos.FieldOptions	parseDelimitedFrom(InputStream input)
static DescriptorProtos.FieldOptions	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static DescriptorProtos.FieldOptions	parseFrom(byte[] data)
static DescriptorProtos.FieldOptions	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static DescriptorProtos.FieldOptions	parseFrom(ByteString data)
static DescriptorProtos.FieldOptions	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static DescriptorProtos.FieldOptions	parseFrom(CodedInputStream input)
static DescriptorProtos.FieldOptions	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static DescriptorProtos.FieldOptions	parseFrom(InputStream input)
static DescriptorProtos.FieldOptions	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static DescriptorProtos.FieldOptions	parseFrom(ByteBuffer data)
static DescriptorProtos.FieldOptions	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<DescriptorProtos.FieldOptions>	parser()
DescriptorProtos.FieldOptions.Builder	toBuilder()	Constructs a builder initialized with the current message.
void	writeTo(CodedOutputStream output)	Serializes the message and writes it to output.

Methods inherited from class GeneratedMessage.ExtendableMessage

extensionsAreInitialized, extensionsIterator, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, makeExtensionsImmutable, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

Methods inherited from class GeneratedMessage

computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, enableAlwaysUseFieldBuildersForTesting, getFieldRaw, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, setAlwaysUseFieldBuildersForTesting, setUnknownFields, warnPre22Gencode, writeReplace, writeString, writeStringNoTag

Methods inherited from class AbstractMessage

compareFields, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashFields, newUninitializedMessageException, setMemoizedSerializedSize, toString

Methods inherited from class AbstractMessageLite

addAll, checkByteStringIsUtf8, getSerializedSize, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface GeneratedMessage.ExtendableMessageOrBuilder

getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

bitField0_

private int bitField0_

CTYPE_FIELD_NUMBER

public static final int CTYPE_FIELD_NUMBER

See Also:

• Constant Field Values

ctype_

private int ctype_

PACKED_FIELD_NUMBER

public static final int PACKED_FIELD_NUMBER

See Also:

• Constant Field Values

packed_

private boolean packed_

JSTYPE_FIELD_NUMBER

public static final int JSTYPE_FIELD_NUMBER

See Also:

• Constant Field Values

jstype_

private int jstype_

LAZY_FIELD_NUMBER

public static final int LAZY_FIELD_NUMBER

See Also:

• Constant Field Values

lazy_

private boolean lazy_

UNVERIFIED_LAZY_FIELD_NUMBER

public static final int UNVERIFIED_LAZY_FIELD_NUMBER

See Also:

• Constant Field Values

unverifiedLazy_

private boolean unverifiedLazy_

DEPRECATED_FIELD_NUMBER

public static final int DEPRECATED_FIELD_NUMBER

See Also:

• Constant Field Values

deprecated_

private boolean deprecated_

WEAK_FIELD_NUMBER

public static final int WEAK_FIELD_NUMBER

See Also:

• Constant Field Values

weak_

private boolean weak_

DEBUG_REDACT_FIELD_NUMBER

public static final int DEBUG_REDACT_FIELD_NUMBER

See Also:

• Constant Field Values

debugRedact_

private boolean debugRedact_

RETENTION_FIELD_NUMBER

public static final int RETENTION_FIELD_NUMBER

See Also:

• Constant Field Values

retention_

private int retention_

TARGETS_FIELD_NUMBER

public static final int TARGETS_FIELD_NUMBER

See Also:

• Constant Field Values

targets_

private Internal.IntList targets_

targets_converter_

private static final Internal.IntListAdapter.IntConverter<DescriptorProtos.FieldOptions.OptionTargetType> targets_converter_

EDITION_DEFAULTS_FIELD_NUMBER

public static final int EDITION_DEFAULTS_FIELD_NUMBER

See Also:

• Constant Field Values

editionDefaults_

private List<DescriptorProtos.FieldOptions.EditionDefault> editionDefaults_

FEATURES_FIELD_NUMBER

public static final int FEATURES_FIELD_NUMBER

See Also:

• Constant Field Values

features_

private DescriptorProtos.FeatureSet features_

FEATURE_SUPPORT_FIELD_NUMBER

public static final int FEATURE_SUPPORT_FIELD_NUMBER

See Also:

• Constant Field Values

featureSupport_

private DescriptorProtos.FieldOptions.FeatureSupport featureSupport_

UNINTERPRETED_OPTION_FIELD_NUMBER

public static final int UNINTERPRETED_OPTION_FIELD_NUMBER

See Also:

• Constant Field Values

uninterpretedOption_

private List<DescriptorProtos.UninterpretedOption> uninterpretedOption_

memoizedIsInitialized

private byte memoizedIsInitialized

DEFAULT_INSTANCE

private static final DescriptorProtos.FieldOptions DEFAULT_INSTANCE

PARSER

private static final Parser<DescriptorProtos.FieldOptions> PARSER

Constructor Details

FieldOptions

private FieldOptions(GeneratedMessage.ExtendableBuilder<DescriptorProtos.FieldOptions, ?> builder)

FieldOptions

private FieldOptions()

Method Details

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Description copied from interface: MessageOrBuilder

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.

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessage

internalGetFieldAccessorTable

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Description copied from class: GeneratedMessage

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.

Specified by:

internalGetFieldAccessorTable in class GeneratedMessage

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.

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.

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.

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.

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.

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.

hasWeak

@Deprecated
public boolean hasWeak()

Deprecated.

google.protobuf.FieldOptions.weak is deprecated. See google/protobuf/descriptor.proto;l=773

DEPRECATED. DO NOT USE!
For Google-internal migration only. Do not use.

optional bool weak = 10 [default = false, deprecated = true];

Specified by:

hasWeak in interface DescriptorProtos.FieldOptionsOrBuilder

Returns:

Whether the weak field is set.

getWeak

@Deprecated
public boolean getWeak()

Deprecated.

google.protobuf.FieldOptions.weak is deprecated. See google/protobuf/descriptor.proto;l=773

DEPRECATED. DO NOT USE!
For Google-internal migration only. Do not use.

optional bool weak = 10 [default = false, deprecated = true];

Specified by:

getWeak in interface DescriptorProtos.FieldOptionsOrBuilder

Returns:

The weak.

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.

hasRetention

public boolean hasRetention()

optional .google.protobuf.FieldOptions.OptionRetention retention = 17;

Specified by:

hasRetention in interface DescriptorProtos.FieldOptionsOrBuilder

Returns:

Whether the retention field is set.

getRetention

public DescriptorProtos.FieldOptions.OptionRetention getRetention()

optional .google.protobuf.FieldOptions.OptionRetention retention = 17;

Specified by:

getRetention in interface DescriptorProtos.FieldOptionsOrBuilder

Returns:

The retention.

getTargetsList

public List<DescriptorProtos.FieldOptions.OptionTargetType> getTargetsList()

repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;

Specified by:

getTargetsList in interface DescriptorProtos.FieldOptionsOrBuilder

Returns:

A list containing the targets.

getTargetsCount

public int getTargetsCount()

repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;

Specified by:

getTargetsCount in interface DescriptorProtos.FieldOptionsOrBuilder

Returns:

The count of targets.

getTargets

public DescriptorProtos.FieldOptions.OptionTargetType getTargets(int index)

repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;

Specified by:

getTargets in interface DescriptorProtos.FieldOptionsOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The targets at the given index.

getEditionDefaultsList

public List<DescriptorProtos.FieldOptions.EditionDefault> getEditionDefaultsList()

repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

Specified by:

getEditionDefaultsList in interface DescriptorProtos.FieldOptionsOrBuilder

getEditionDefaultsOrBuilderList

public List<? extends DescriptorProtos.FieldOptions.EditionDefaultOrBuilder> getEditionDefaultsOrBuilderList()

repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

Specified by:

getEditionDefaultsOrBuilderList in interface DescriptorProtos.FieldOptionsOrBuilder

getEditionDefaultsCount

public int getEditionDefaultsCount()

repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

Specified by:

getEditionDefaultsCount in interface DescriptorProtos.FieldOptionsOrBuilder

getEditionDefaults

public DescriptorProtos.FieldOptions.EditionDefault getEditionDefaults(int index)

repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

Specified by:

getEditionDefaults in interface DescriptorProtos.FieldOptionsOrBuilder

getEditionDefaultsOrBuilder

public DescriptorProtos.FieldOptions.EditionDefaultOrBuilder getEditionDefaultsOrBuilder(int index)

repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

Specified by:

getEditionDefaultsOrBuilder in interface DescriptorProtos.FieldOptionsOrBuilder

hasFeatures

public boolean hasFeatures()

Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special
cases like the proto compiler. Other uses are discouraged and
developers should rely on the protoreflect APIs for their client language.

optional .google.protobuf.FeatureSet features = 21;

Specified by:

hasFeatures in interface DescriptorProtos.FieldOptionsOrBuilder

Returns:

Whether the features field is set.

getFeatures

public DescriptorProtos.FeatureSet getFeatures()

Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special
cases like the proto compiler. Other uses are discouraged and
developers should rely on the protoreflect APIs for their client language.

optional .google.protobuf.FeatureSet features = 21;

Specified by:

getFeatures in interface DescriptorProtos.FieldOptionsOrBuilder

Returns:

The features.

getFeaturesOrBuilder

public DescriptorProtos.FeatureSetOrBuilder getFeaturesOrBuilder()

Any features defined in the specific edition.
WARNING: This field should only be used by protobuf plugins or special
cases like the proto compiler. Other uses are discouraged and
developers should rely on the protoreflect APIs for their client language.

optional .google.protobuf.FeatureSet features = 21;

Specified by:

getFeaturesOrBuilder in interface DescriptorProtos.FieldOptionsOrBuilder

hasFeatureSupport

public boolean hasFeatureSupport()

optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;

Specified by:

hasFeatureSupport in interface DescriptorProtos.FieldOptionsOrBuilder

Returns:

Whether the featureSupport field is set.

getFeatureSupport

public DescriptorProtos.FieldOptions.FeatureSupport getFeatureSupport()

optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;

Specified by:

getFeatureSupport in interface DescriptorProtos.FieldOptionsOrBuilder

Returns:

The featureSupport.

getFeatureSupportOrBuilder

public DescriptorProtos.FieldOptions.FeatureSupportOrBuilder getFeatureSupportOrBuilder()

optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;

Specified by:

getFeatureSupportOrBuilder in interface DescriptorProtos.FieldOptionsOrBuilder

getUninterpretedOptionList

public List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Specified by:

getUninterpretedOptionList in interface DescriptorProtos.FieldOptionsOrBuilder

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;

Specified by:

getUninterpretedOptionOrBuilderList in interface DescriptorProtos.FieldOptionsOrBuilder

getUninterpretedOptionCount

public int getUninterpretedOptionCount()

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Specified by:

getUninterpretedOptionCount in interface DescriptorProtos.FieldOptionsOrBuilder

getUninterpretedOption

public DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)

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

repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

Specified by:

getUninterpretedOption in interface DescriptorProtos.FieldOptionsOrBuilder

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;

Specified by:

getUninterpretedOptionOrBuilder in interface DescriptorProtos.FieldOptionsOrBuilder

isInitialized

public final boolean isInitialized()

Description copied from interface: MessageLiteOrBuilder

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

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage.ExtendableMessage<DescriptorProtos.FieldOptions>

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Description copied from interface: MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Description copied from interface: MessageLite

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that. If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessage

equals

public boolean equals(Object obj)

Description copied from interface: Message

Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

Parameters:

obj - object to be compared for equality with this message

Returns:

true if the specified object is equal to this message

hashCode

public int hashCode()

Description copied from interface: Message

Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

Returns:

the hash code value for this message

See Also:

• Map.hashCode()

parseFrom

public static DescriptorProtos.FieldOptions parseFrom(ByteBuffer data)
                                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DescriptorProtos.FieldOptions parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DescriptorProtos.FieldOptions parseFrom(ByteString data)
                                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DescriptorProtos.FieldOptions parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DescriptorProtos.FieldOptions parseFrom(byte[] data)
                                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DescriptorProtos.FieldOptions parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DescriptorProtos.FieldOptions parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static DescriptorProtos.FieldOptions parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static DescriptorProtos.FieldOptions parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static DescriptorProtos.FieldOptions parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseFrom

public static DescriptorProtos.FieldOptions parseFrom(CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static DescriptorProtos.FieldOptions parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

newBuilderForType

public DescriptorProtos.FieldOptions.Builder newBuilderForType()

Description copied from interface: MessageLite

Constructs a new builder for a message of the same type as this message.

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static DescriptorProtos.FieldOptions.Builder newBuilder()

newBuilder

public static DescriptorProtos.FieldOptions.Builder newBuilder(DescriptorProtos.FieldOptions prototype)

toBuilder

public DescriptorProtos.FieldOptions.Builder toBuilder()

Description copied from interface: MessageLite

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected DescriptorProtos.FieldOptions.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Description copied from class: AbstractMessage

Create a nested builder.

Overrides:

newBuilderForType in class AbstractMessage

getDefaultInstance

public static DescriptorProtos.FieldOptions getDefaultInstance()

parser

public static Parser<DescriptorProtos.FieldOptions> parser()

getParserForType

public Parser<DescriptorProtos.FieldOptions> getParserForType()

Description copied from class: GeneratedMessage

TODO: Remove this unnecessary intermediate implementation of this method.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessage

getDefaultInstanceForType

public DescriptorProtos.FieldOptions getDefaultInstanceForType()

Description copied from interface: MessageLiteOrBuilder

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.

Specified by:

getDefaultInstanceForType in interface GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder