Package com.google.protobuf

Class Option.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Option.Builder>

com.google.protobuf.Option.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, OptionOrBuilder, java.lang.Cloneable

Enclosing class:

Option

public static final class Option.Builder
extends GeneratedMessageV3.Builder<Option.Builder>
implements OptionOrBuilder

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

Protobuf type google.protobuf.Option

Method Summary

Modifier and Type	Method	Description
Option.Builder	addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)	Like setRepeatedField, but appends the value as a new element.
Option	build()	Constructs the message based on the state of the Builder.
Option	buildPartial()	Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields.
Option.Builder	clear()	Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
Option.Builder	clearField(Descriptors.FieldDescriptor field)	Clears the field.
Option.Builder	clearName()	The option's name.
Option.Builder	clearOneof(Descriptors.OneofDescriptor oneof)	TODO(jieluo): Clear it when all subclasses have implemented this method.
Option.Builder	clearValue()	The option's value packed in an Any message.
Option.Builder	clone()	Clones the Builder.
Option	getDefaultInstanceForType()	Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()	Get the message's type's descriptor.
java.lang.String	getName()	The option's name.
ByteString	getNameBytes()	The option's name.
Any	getValue()	The option's value packed in an Any message.
Any.Builder	getValueBuilder()	The option's value packed in an Any message.
AnyOrBuilder	getValueOrBuilder()	The option's value packed in an Any message.
boolean	hasValue()	The option's value packed in an Any message.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
boolean	isInitialized()	Returns true if all required fields in the message and all embedded messages are set, false otherwise.
Option.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)	Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.
Option.Builder	mergeFrom(Message other)	Merge other into the message being built.
Option.Builder	mergeFrom(Option other)
Option.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)	Merge some unknown fields into the UnknownFieldSet for this message.
Option.Builder	mergeValue(Any value)	The option's value packed in an Any message.
Option.Builder	setField(Descriptors.FieldDescriptor field, java.lang.Object value)	Sets a field to the given value.
Option.Builder	setName(java.lang.String value)	The option's name.
Option.Builder	setNameBytes(ByteString value)	The option's name.
Option.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)	Sets an element of a repeated field to the given value.
Option.Builder	setUnknownFields(UnknownFieldSet unknownFields)	Set the UnknownFieldSet for this message.
Option.Builder	setValue(Any value)	The option's value packed in an Any message.
Option.Builder	setValue(Any.Builder builderForValue)	The option's value packed in an Any message.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Description copied from class: GeneratedMessageV3.Builder

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.Builder<Option.Builder>

clear

public Option.Builder clear()

Description copied from class: GeneratedMessageV3.Builder

Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<Option.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Description copied from interface: Message.Builder

Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<Option.Builder>

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

build

public Option build()

Description copied from interface: MessageLite.Builder

Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public Option buildPartial()

Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public Option.Builder clone()

Description copied from interface: MessageLite.Builder

Clones the Builder.

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<Option.Builder>

See Also:

Object.clone()

setField

public Option.Builder setField(Descriptors.FieldDescriptor field,
                               java.lang.Object value)

Description copied from interface: Message.Builder

Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getField(Descriptors.FieldDescriptor) would return.

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<Option.Builder>

clearField

public Option.Builder clearField(Descriptors.FieldDescriptor field)

Description copied from interface: Message.Builder

Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<Option.Builder>

clearOneof

public Option.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Description copied from class: AbstractMessage.Builder

TODO(jieluo): Clear it when all subclasses have implemented this method.

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<Option.Builder>

setRepeatedField

public Option.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                       int index,
                                       java.lang.Object value)

Description copied from interface: Message.Builder

Sets an element of a repeated field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int) would return.

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<Option.Builder>

addRepeatedField

public Option.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                       java.lang.Object value)

Description copied from interface: Message.Builder

Like setRepeatedField, but appends the value as a new element.

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<Option.Builder>

mergeFrom

public Option.Builder mergeFrom(Message other)

Description copied from interface: Message.Builder

Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()).

Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
* For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements in other are concatenated with the elements in this message.
* For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.

This is equivalent to the Message::MergeFrom method in C++.

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Option.Builder>

mergeFrom

public Option.Builder mergeFrom(Option other)

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.Builder<Option.Builder>

mergeFrom

public Option.Builder mergeFrom(CodedInputStream input,
                                ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException

Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Option.Builder>

Throws:

java.io.IOException

getName

public java.lang.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.

setName

public Option.Builder setName(java.lang.String value)

 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;

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public Option.Builder clearName()

 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;

Returns:

This builder for chaining.

setNameBytes

public Option.Builder setNameBytes(ByteString value)

 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;

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

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.

setValue

public Option.Builder setValue(Any value)

 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;

setValue

public Option.Builder setValue(Any.Builder builderForValue)

 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;

mergeValue

public Option.Builder mergeValue(Any value)

 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;

clearValue

public Option.Builder clearValue()

 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;

getValueBuilder

public Any.Builder getValueBuilder()

 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;

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

setUnknownFields

public final Option.Builder setUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Set the UnknownFieldSet for this message.

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<Option.Builder>

mergeUnknownFields

public final Option.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Merge some unknown fields into the UnknownFieldSet for this message.

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<Option.Builder>