Package com.google.protobuf
Class Type.Builder
- All Implemented Interfaces:
Message.Builder
,MessageLite.Builder
,MessageLiteOrBuilder
,MessageOrBuilder
,TypeOrBuilder
,Cloneable
- Enclosing class:
Type
public static final class Type.Builder
extends GeneratedMessageV3.Builder<Type.Builder>
implements TypeOrBuilder
A protocol buffer message type.Protobuf type
google.protobuf.Type
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private Object
private LazyStringList
private SourceContext
private int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAllFields
(Iterable<? extends Field> values) The list of fields.addAllOneofs
(Iterable<String> values) The list of types appearing in `oneof` definitions in this type.addAllOptions
(Iterable<? extends Option> values) The protocol buffer options.The list of fields.addFields
(int index, Field.Builder builderForValue) The list of fields.The list of fields.addFields
(Field.Builder builderForValue) The list of fields.The list of fields.addFieldsBuilder
(int index) The list of fields.The list of types appearing in `oneof` definitions in this type.addOneofsBytes
(ByteString value) The list of types appearing in `oneof` definitions in this type.addOptions
(int index, Option value) The protocol buffer options.addOptions
(int index, Option.Builder builderForValue) The protocol buffer options.addOptions
(Option value) The protocol buffer options.addOptions
(Option.Builder builderForValue) The protocol buffer options.The protocol buffer options.addOptionsBuilder
(int index) The protocol buffer options.addRepeatedField
(Descriptors.FieldDescriptor field, Object value) LikesetRepeatedField
, but appends the value as a new element.build()
Constructs the message based on the state of the Builder.LikeMessageLite.Builder.build()
, but does not throw an exception if the message is missing required fields.clear()
Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.Clears the field.The list of fields.The fully qualified message name.TODO(jieluo): Clear it when all subclasses have implemented this method.The list of types appearing in `oneof` definitions in this type.The protocol buffer options.The source context.The source syntax.clone()
Clones the Builder.private void
private void
private void
Get an instance of the type with no fields set.static final Descriptors.Descriptor
Get the message's type's descriptor.getFields
(int index) The list of fields.getFieldsBuilder
(int index) The list of fields.The list of fields.int
The list of fields.The list of fields.getFieldsOrBuilder
(int index) The list of fields.List
<? extends FieldOrBuilder> The list of fields.getName()
The fully qualified message name.The fully qualified message name.getOneofs
(int index) The list of types appearing in `oneof` definitions in this type.getOneofsBytes
(int index) The list of types appearing in `oneof` definitions in this type.int
The list of types appearing in `oneof` definitions in this type.The list of types appearing in `oneof` definitions in this type.getOptions
(int index) The protocol buffer options.getOptionsBuilder
(int index) The protocol buffer options.The protocol buffer options.int
The protocol buffer options.The protocol buffer options.getOptionsOrBuilder
(int index) The protocol buffer options.List
<? extends OptionOrBuilder> The protocol buffer options.The source context.The source context.The source context.The source context.The source syntax.int
The source syntax.boolean
The source context.protected GeneratedMessageV3.FieldAccessorTable
Get the FieldAccessorTable for this type.final boolean
Returns true if all required fields in the message and all embedded messages are set, false otherwise.mergeFrom
(CodedInputStream input, ExtensionRegistryLite extensionRegistry) LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions.Mergeother
into the message being built.mergeSourceContext
(SourceContext value) The source context.final Type.Builder
mergeUnknownFields
(UnknownFieldSet unknownFields) Merge some unknown fields into theUnknownFieldSet
for this message.removeFields
(int index) The list of fields.removeOptions
(int index) The protocol buffer options.setField
(Descriptors.FieldDescriptor field, Object value) Sets a field to the given value.The list of fields.setFields
(int index, Field.Builder builderForValue) The list of fields.The fully qualified message name.setNameBytes
(ByteString value) The fully qualified message name.The list of types appearing in `oneof` definitions in this type.setOptions
(int index, Option value) The protocol buffer options.setOptions
(int index, Option.Builder builderForValue) The protocol buffer options.setRepeatedField
(Descriptors.FieldDescriptor field, int index, Object value) Sets an element of a repeated field to the given value.setSourceContext
(SourceContext value) The source context.setSourceContext
(SourceContext.Builder builderForValue) The source context.The source syntax.setSyntaxValue
(int value) The source syntax.final Type.Builder
setUnknownFields
(UnknownFieldSet unknownFields) Set theUnknownFieldSet
for this message.Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
dispose, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, 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
-
Field Details
-
bitField0_
private int bitField0_ -
name_
-
fields_
-
fieldsBuilder_
-
oneofs_
-
options_
-
optionsBuilder_
-
sourceContext_
-
sourceContextBuilder_
private SingleFieldBuilderV3<SourceContext,SourceContext.Builder, sourceContextBuilder_SourceContextOrBuilder> -
syntax_
private int syntax_
-
-
Constructor Details
-
Builder
private Builder() -
Builder
-
-
Method Details
-
getDescriptor
-
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 classGeneratedMessageV3.Builder<Type.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 interfaceMessage.Builder
- Specified by:
clear
in interfaceMessageLite.Builder
- Overrides:
clear
in classGeneratedMessageV3.Builder<Type.Builder>
-
getDescriptorForType
Description copied from interface:Message.Builder
Get the message's type's descriptor. SeeMessageOrBuilder.getDescriptorForType()
.- Specified by:
getDescriptorForType
in interfaceMessage.Builder
- Specified by:
getDescriptorForType
in interfaceMessageOrBuilder
- Overrides:
getDescriptorForType
in classGeneratedMessageV3.Builder<Type.Builder>
-
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 thegetDefaultInstance()
method of generated message classes in that this method is an abstract method of theMessageLite
interface whereasgetDefaultInstance()
is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForType
in interfaceMessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfaceMessageOrBuilder
-
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 interfaceMessage.Builder
- Specified by:
build
in interfaceMessageLite.Builder
-
buildPartial
Description copied from interface:MessageLite.Builder
LikeMessageLite.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 interfaceMessage.Builder
- Specified by:
buildPartial
in interfaceMessageLite.Builder
-
clone
Description copied from interface:MessageLite.Builder
Clones the Builder.- Specified by:
clone
in interfaceMessage.Builder
- Specified by:
clone
in interfaceMessageLite.Builder
- Overrides:
clone
in classGeneratedMessageV3.Builder<Type.Builder>
- See Also:
-
setField
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 thatMessageOrBuilder.getField(Descriptors.FieldDescriptor)
would return.- Specified by:
setField
in interfaceMessage.Builder
- Overrides:
setField
in classGeneratedMessageV3.Builder<Type.Builder>
-
clearField
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 interfaceMessage.Builder
- Overrides:
clearField
in classGeneratedMessageV3.Builder<Type.Builder>
-
clearOneof
Description copied from class:AbstractMessage.Builder
TODO(jieluo): Clear it when all subclasses have implemented this method.- Specified by:
clearOneof
in interfaceMessage.Builder
- Overrides:
clearOneof
in classGeneratedMessageV3.Builder<Type.Builder>
-
setRepeatedField
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 thatMessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int)
would return.- Specified by:
setRepeatedField
in interfaceMessage.Builder
- Overrides:
setRepeatedField
in classGeneratedMessageV3.Builder<Type.Builder>
-
addRepeatedField
Description copied from interface:Message.Builder
LikesetRepeatedField
, but appends the value as a new element.- Specified by:
addRepeatedField
in interfaceMessage.Builder
- Overrides:
addRepeatedField
in classGeneratedMessageV3.Builder<Type.Builder>
-
mergeFrom
Description copied from interface:Message.Builder
Mergeother
into the message being built.other
must have the exact same type asthis
(i.e.getDescriptorForType() == other.getDescriptorForType()
).Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set inother
, thenother
's value overwrites the value in this message.
* For singular message fields, if the field is set inother
, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements inother
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 interfaceMessage.Builder
- Overrides:
mergeFrom
in classAbstractMessage.Builder<Type.Builder>
-
mergeFrom
-
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.- Specified by:
isInitialized
in interfaceMessageLiteOrBuilder
- Overrides:
isInitialized
in classGeneratedMessageV3.Builder<Type.Builder>
-
mergeFrom
public Type.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from interface:MessageLite.Builder
LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions. The extensions that you want to be able to parse must be registered inextensionRegistry
. Extensions not in the registry will be treated as unknown fields.- Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfaceMessageLite.Builder
- Overrides:
mergeFrom
in classAbstractMessage.Builder<Type.Builder>
- Throws:
IOException
-
getName
The fully qualified message name.
string name = 1;
- Specified by:
getName
in interfaceTypeOrBuilder
- Returns:
- The name.
-
getNameBytes
The fully qualified message name.
string name = 1;
- Specified by:
getNameBytes
in interfaceTypeOrBuilder
- Returns:
- The bytes for name.
-
setName
The fully qualified message name.
string name = 1;
- Parameters:
value
- The name to set.- Returns:
- This builder for chaining.
-
clearName
The fully qualified message name.
string name = 1;
- Returns:
- This builder for chaining.
-
setNameBytes
The fully qualified message name.
string name = 1;
- Parameters:
value
- The bytes for name to set.- Returns:
- This builder for chaining.
-
ensureFieldsIsMutable
private void ensureFieldsIsMutable() -
getFieldsList
The list of fields.
repeated .google.protobuf.Field fields = 2;
- Specified by:
getFieldsList
in interfaceTypeOrBuilder
-
getFieldsCount
public int getFieldsCount()The list of fields.
repeated .google.protobuf.Field fields = 2;
- Specified by:
getFieldsCount
in interfaceTypeOrBuilder
-
getFields
The list of fields.
repeated .google.protobuf.Field fields = 2;
- Specified by:
getFields
in interfaceTypeOrBuilder
-
setFields
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
setFields
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
addFields
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
addFields
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
addFields
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
addFields
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
addAllFields
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
clearFields
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
removeFields
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
getFieldsBuilder
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
getFieldsOrBuilder
The list of fields.
repeated .google.protobuf.Field fields = 2;
- Specified by:
getFieldsOrBuilder
in interfaceTypeOrBuilder
-
getFieldsOrBuilderList
The list of fields.
repeated .google.protobuf.Field fields = 2;
- Specified by:
getFieldsOrBuilderList
in interfaceTypeOrBuilder
-
addFieldsBuilder
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
addFieldsBuilder
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
getFieldsBuilderList
The list of fields.
repeated .google.protobuf.Field fields = 2;
-
getFieldsFieldBuilder
-
ensureOneofsIsMutable
private void ensureOneofsIsMutable() -
getOneofsList
The list of types appearing in `oneof` definitions in this type.
repeated string oneofs = 3;
- Specified by:
getOneofsList
in interfaceTypeOrBuilder
- Returns:
- A list containing the oneofs.
-
getOneofsCount
public int getOneofsCount()The list of types appearing in `oneof` definitions in this type.
repeated string oneofs = 3;
- Specified by:
getOneofsCount
in interfaceTypeOrBuilder
- Returns:
- The count of oneofs.
-
getOneofs
The list of types appearing in `oneof` definitions in this type.
repeated string oneofs = 3;
- Specified by:
getOneofs
in interfaceTypeOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The oneofs at the given index.
-
getOneofsBytes
The list of types appearing in `oneof` definitions in this type.
repeated string oneofs = 3;
- Specified by:
getOneofsBytes
in interfaceTypeOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the oneofs at the given index.
-
setOneofs
The list of types appearing in `oneof` definitions in this type.
repeated string oneofs = 3;
- Parameters:
index
- The index to set the value at.value
- The oneofs to set.- Returns:
- This builder for chaining.
-
addOneofs
The list of types appearing in `oneof` definitions in this type.
repeated string oneofs = 3;
- Parameters:
value
- The oneofs to add.- Returns:
- This builder for chaining.
-
addAllOneofs
The list of types appearing in `oneof` definitions in this type.
repeated string oneofs = 3;
- Parameters:
values
- The oneofs to add.- Returns:
- This builder for chaining.
-
clearOneofs
The list of types appearing in `oneof` definitions in this type.
repeated string oneofs = 3;
- Returns:
- This builder for chaining.
-
addOneofsBytes
The list of types appearing in `oneof` definitions in this type.
repeated string oneofs = 3;
- Parameters:
value
- The bytes of the oneofs to add.- Returns:
- This builder for chaining.
-
ensureOptionsIsMutable
private void ensureOptionsIsMutable() -
getOptionsList
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
- Specified by:
getOptionsList
in interfaceTypeOrBuilder
-
getOptionsCount
public int getOptionsCount()The protocol buffer options.
repeated .google.protobuf.Option options = 4;
- Specified by:
getOptionsCount
in interfaceTypeOrBuilder
-
getOptions
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
- Specified by:
getOptions
in interfaceTypeOrBuilder
-
setOptions
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
setOptions
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
addOptions
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
addOptions
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
addOptions
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
addOptions
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
addAllOptions
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
clearOptions
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
removeOptions
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
getOptionsBuilder
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
getOptionsOrBuilder
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
- Specified by:
getOptionsOrBuilder
in interfaceTypeOrBuilder
-
getOptionsOrBuilderList
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
- Specified by:
getOptionsOrBuilderList
in interfaceTypeOrBuilder
-
addOptionsBuilder
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
addOptionsBuilder
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
getOptionsBuilderList
The protocol buffer options.
repeated .google.protobuf.Option options = 4;
-
getOptionsFieldBuilder
-
hasSourceContext
public boolean hasSourceContext()The source context.
.google.protobuf.SourceContext source_context = 5;
- Specified by:
hasSourceContext
in interfaceTypeOrBuilder
- Returns:
- Whether the sourceContext field is set.
-
getSourceContext
The source context.
.google.protobuf.SourceContext source_context = 5;
- Specified by:
getSourceContext
in interfaceTypeOrBuilder
- Returns:
- The sourceContext.
-
setSourceContext
The source context.
.google.protobuf.SourceContext source_context = 5;
-
setSourceContext
The source context.
.google.protobuf.SourceContext source_context = 5;
-
mergeSourceContext
The source context.
.google.protobuf.SourceContext source_context = 5;
-
clearSourceContext
The source context.
.google.protobuf.SourceContext source_context = 5;
-
getSourceContextBuilder
The source context.
.google.protobuf.SourceContext source_context = 5;
-
getSourceContextOrBuilder
The source context.
.google.protobuf.SourceContext source_context = 5;
- Specified by:
getSourceContextOrBuilder
in interfaceTypeOrBuilder
-
getSourceContextFieldBuilder
private SingleFieldBuilderV3<SourceContext,SourceContext.Builder, getSourceContextFieldBuilder()SourceContextOrBuilder> The source context.
.google.protobuf.SourceContext source_context = 5;
-
getSyntaxValue
public int getSyntaxValue()The source syntax.
.google.protobuf.Syntax syntax = 6;
- Specified by:
getSyntaxValue
in interfaceTypeOrBuilder
- Returns:
- The enum numeric value on the wire for syntax.
-
setSyntaxValue
The source syntax.
.google.protobuf.Syntax syntax = 6;
- Parameters:
value
- The enum numeric value on the wire for syntax to set.- Returns:
- This builder for chaining.
-
getSyntax
The source syntax.
.google.protobuf.Syntax syntax = 6;
- Specified by:
getSyntax
in interfaceTypeOrBuilder
- Returns:
- The syntax.
-
setSyntax
The source syntax.
.google.protobuf.Syntax syntax = 6;
- Parameters:
value
- The syntax to set.- Returns:
- This builder for chaining.
-
clearSyntax
The source syntax.
.google.protobuf.Syntax syntax = 6;
- Returns:
- This builder for chaining.
-
setUnknownFields
Description copied from interface:Message.Builder
Set theUnknownFieldSet
for this message.- Specified by:
setUnknownFields
in interfaceMessage.Builder
- Overrides:
setUnknownFields
in classGeneratedMessageV3.Builder<Type.Builder>
-
mergeUnknownFields
Description copied from interface:Message.Builder
Merge some unknown fields into theUnknownFieldSet
for this message.- Specified by:
mergeUnknownFields
in interfaceMessage.Builder
- Overrides:
mergeUnknownFields
in classGeneratedMessageV3.Builder<Type.Builder>
-