Class Option

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.protobuf.Option

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, OptionOrBuilder, Serializable

public final class Option
extends GeneratedMessageV3
implements OptionOrBuilder

A protocol buffer option, which can be attached to a message, field,
enumeration, etc.

Protobuf type google.protobuf.Option

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Option.Builder	A protocol buffer option, which can be attached to a message, field, enumeration, etc.

Nested classes/interfaces inherited from class GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>, GeneratedMessageV3.ExtendableMessage<MessageType>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>, GeneratedMessageV3.ExtensionDescriptorRetriever, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
private static final Option	DEFAULT_INSTANCE
private byte	memoizedIsInitialized
private Object	name_
static final int	NAME_FIELD_NUMBER
private static final Parser<Option>	PARSER
private static final long	serialVersionUID
private Any	value_
static final int	VALUE_FIELD_NUMBER

Fields inherited from class GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Option()
private	Option(GeneratedMessageV3.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Compares the specified object with this message for equality.
static Option	getDefaultInstance()
Option	getDefaultInstanceForType()	Get an instance of the type with no fields set.
static final Descriptors.Descriptor	getDescriptor()
String	getName()	The option's name.
ByteString	getNameBytes()	The option's name.
Parser<Option>	getParserForType()	Gets the parser for a message of the same type as this message.
int	getSerializedSize()	Get the number of bytes required to encode this message.
final UnknownFieldSet	getUnknownFields()	Get the UnknownFieldSet for this message.
Any	getValue()	The option's value packed in an Any message.
AnyOrBuilder	getValueOrBuilder()	The option's value packed in an Any message.
int	hashCode()	Returns the hash code value for this message.
boolean	hasValue()	The option's value packed in an Any message.
protected GeneratedMessageV3.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 Option.Builder	newBuilder()
static Option.Builder	newBuilder(Option prototype)
Option.Builder	newBuilderForType()	Constructs a new builder for a message of the same type as this message.
protected Option.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)	TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)	Creates a new instance of this message type.
static Option	parseDelimitedFrom(InputStream input)
static Option	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Option	parseFrom(byte[] data)
static Option	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Option	parseFrom(ByteString data)
static Option	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Option	parseFrom(CodedInputStream input)
static Option	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Option	parseFrom(InputStream input)
static Option	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Option	parseFrom(ByteBuffer data)
static Option	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<Option>	parser()
Option.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 GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, enableAlwaysUseFieldBuildersForTesting, getAllFields, getAllFieldsRaw, getDescriptorForType, getField, getFieldRaw, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, setAlwaysUseFieldBuildersForTesting, writeReplace, writeString, writeStringNoTag

Methods inherited from class AbstractMessage

compareFields, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, newUninitializedMessageException, setMemoizedSerializedSize, toString

Methods inherited from class AbstractMessageLite

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

Methods inherited from class Object

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

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

• Constant Field Values

name_

private volatile Object name_

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

value_

private Any value_

memoizedIsInitialized

private byte memoizedIsInitialized

DEFAULT_INSTANCE

private static final Option DEFAULT_INSTANCE

PARSER

private static final Parser<Option> PARSER

Constructor Details

Option

private Option(GeneratedMessageV3.Builder<?> builder)

Option

private Option()

Method Details

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Description copied from class: GeneratedMessageV3

Creates a new instance of this message type. Overridden in the generated code.

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Description copied from class: GeneratedMessageV3

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 GeneratedMessageV3

getName

public String getName()

The option's name. For protobuf built-in options (options defined in
descriptor.proto), this is the short name. For example, `"map_entry"`.
For custom options, it should be the fully-qualified name. For example,
`"google.api.http"`.

string name = 1;

Specified by:

getName in interface OptionOrBuilder

Returns:

The name.

getNameBytes

public ByteString getNameBytes()

The option's name. For protobuf built-in options (options defined in
descriptor.proto), this is the short name. For example, `"map_entry"`.
For custom options, it should be the fully-qualified name. For example,
`"google.api.http"`.

string name = 1;

Specified by:

getNameBytes in interface OptionOrBuilder

Returns:

The bytes for name.

hasValue

public boolean hasValue()

The option's value packed in an Any message. If the value is a primitive,
the corresponding wrapper type defined in google/protobuf/wrappers.proto
should be used. If the value is an enum, it should be stored as an int32
value using the google.protobuf.Int32Value type.

.google.protobuf.Any value = 2;

Specified by:

hasValue in interface OptionOrBuilder

Returns:

Whether the value field is set.

getValue

public Any getValue()

The option's value packed in an Any message. If the value is a primitive,
the corresponding wrapper type defined in google/protobuf/wrappers.proto
should be used. If the value is an enum, it should be stored as an int32
value using the google.protobuf.Int32Value type.

.google.protobuf.Any value = 2;

Specified by:

getValue in interface OptionOrBuilder

Returns:

The value.

getValueOrBuilder

public AnyOrBuilder getValueOrBuilder()

The option's value packed in an Any message. If the value is a primitive,
the corresponding wrapper type defined in google/protobuf/wrappers.proto
should be used. If the value is an enum, it should be stored as an int32
value using the google.protobuf.Int32Value type.

.google.protobuf.Any value = 2;

Specified by:

getValueOrBuilder in interface OptionOrBuilder

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 GeneratedMessageV3

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 GeneratedMessageV3

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 GeneratedMessageV3

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 Option parseFrom(ByteBuffer data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Option parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Option parseFrom(ByteString data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Option parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Option parseFrom(byte[] data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Option parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Option parseFrom(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Option parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Option parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Option parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static Option parseFrom(CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Option parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

newBuilderForType

public Option.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 Option.Builder newBuilder()

newBuilder

public static Option.Builder newBuilder(Option prototype)

toBuilder

public Option.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 Option.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Description copied from class: GeneratedMessageV3

TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Option getDefaultInstance()

parser

public static Parser<Option> parser()

getParserForType

public Parser<Option> getParserForType()

Description copied from interface: MessageLite

Gets the parser for a message of the same type as this message.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Option 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 MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder