Package com.google.protobuf
Class Enum.Builder
- All Implemented Interfaces:
EnumOrBuilder
,Message.Builder
,MessageLite.Builder
,MessageLiteOrBuilder
,MessageOrBuilder
,Cloneable
- Enclosing class:
Enum
public static final class Enum.Builder
extends GeneratedMessageV3.Builder<Enum.Builder>
implements EnumOrBuilder
Enum type definition.Protobuf type
google.protobuf.Enum
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAllEnumvalue
(Iterable<? extends EnumValue> values) Enum value definitions.addAllOptions
(Iterable<? extends Option> values) Protocol buffer options.addEnumvalue
(int index, EnumValue value) Enum value definitions.addEnumvalue
(int index, EnumValue.Builder builderForValue) Enum value definitions.addEnumvalue
(EnumValue value) Enum value definitions.addEnumvalue
(EnumValue.Builder builderForValue) Enum value definitions.Enum value definitions.addEnumvalueBuilder
(int index) Enum value definitions.addOptions
(int index, Option value) Protocol buffer options.addOptions
(int index, Option.Builder builderForValue) Protocol buffer options.addOptions
(Option value) Protocol buffer options.addOptions
(Option.Builder builderForValue) Protocol buffer options.Protocol buffer options.addOptionsBuilder
(int index) 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.Enum value definitions.Clears the field.Enum type name.TODO(jieluo): Clear it when all subclasses have implemented this method.Protocol buffer options.The source context.The source syntax.clone()
Clones the Builder.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.getEnumvalue
(int index) Enum value definitions.getEnumvalueBuilder
(int index) Enum value definitions.Enum value definitions.int
Enum value definitions.Enum value definitions.getEnumvalueOrBuilder
(int index) Enum value definitions.List
<? extends EnumValueOrBuilder> Enum value definitions.getName()
Enum type name.Enum type name.getOptions
(int index) Protocol buffer options.getOptionsBuilder
(int index) Protocol buffer options.Protocol buffer options.int
Protocol buffer options.Protocol buffer options.getOptionsOrBuilder
(int index) Protocol buffer options.List
<? extends OptionOrBuilder> 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 Enum.Builder
mergeUnknownFields
(UnknownFieldSet unknownFields) Merge some unknown fields into theUnknownFieldSet
for this message.removeEnumvalue
(int index) Enum value definitions.removeOptions
(int index) Protocol buffer options.setEnumvalue
(int index, EnumValue value) Enum value definitions.setEnumvalue
(int index, EnumValue.Builder builderForValue) Enum value definitions.setField
(Descriptors.FieldDescriptor field, Object value) Sets a field to the given value.Enum type name.setNameBytes
(ByteString value) Enum type name.setOptions
(int index, Option value) Protocol buffer options.setOptions
(int index, Option.Builder builderForValue) 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 Enum.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_
-
enumvalue_
-
enumvalueBuilder_
-
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<Enum.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<Enum.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<Enum.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<Enum.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<Enum.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<Enum.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<Enum.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<Enum.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<Enum.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<Enum.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<Enum.Builder>
-
mergeFrom
public Enum.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<Enum.Builder>
- Throws:
IOException
-
getName
Enum type name.
string name = 1;
- Specified by:
getName
in interfaceEnumOrBuilder
- Returns:
- The name.
-
getNameBytes
Enum type name.
string name = 1;
- Specified by:
getNameBytes
in interfaceEnumOrBuilder
- Returns:
- The bytes for name.
-
setName
Enum type name.
string name = 1;
- Parameters:
value
- The name to set.- Returns:
- This builder for chaining.
-
clearName
Enum type name.
string name = 1;
- Returns:
- This builder for chaining.
-
setNameBytes
Enum type name.
string name = 1;
- Parameters:
value
- The bytes for name to set.- Returns:
- This builder for chaining.
-
ensureEnumvalueIsMutable
private void ensureEnumvalueIsMutable() -
getEnumvalueList
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
- Specified by:
getEnumvalueList
in interfaceEnumOrBuilder
-
getEnumvalueCount
public int getEnumvalueCount()Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
- Specified by:
getEnumvalueCount
in interfaceEnumOrBuilder
-
getEnumvalue
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
- Specified by:
getEnumvalue
in interfaceEnumOrBuilder
-
setEnumvalue
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
setEnumvalue
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
addEnumvalue
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
addEnumvalue
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
addEnumvalue
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
addEnumvalue
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
addAllEnumvalue
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
clearEnumvalue
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
removeEnumvalue
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
getEnumvalueBuilder
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
getEnumvalueOrBuilder
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
- Specified by:
getEnumvalueOrBuilder
in interfaceEnumOrBuilder
-
getEnumvalueOrBuilderList
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
- Specified by:
getEnumvalueOrBuilderList
in interfaceEnumOrBuilder
-
addEnumvalueBuilder
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
addEnumvalueBuilder
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
getEnumvalueBuilderList
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;
-
getEnumvalueFieldBuilder
private RepeatedFieldBuilderV3<EnumValue,EnumValue.Builder, getEnumvalueFieldBuilder()EnumValueOrBuilder> -
ensureOptionsIsMutable
private void ensureOptionsIsMutable() -
getOptionsList
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsList
in interfaceEnumOrBuilder
-
getOptionsCount
public int getOptionsCount()Protocol buffer options.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsCount
in interfaceEnumOrBuilder
-
getOptions
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptions
in interfaceEnumOrBuilder
-
setOptions
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
setOptions
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
addOptions
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
addOptions
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
addOptions
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
addOptions
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
addAllOptions
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
clearOptions
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
removeOptions
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
getOptionsBuilder
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
getOptionsOrBuilder
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsOrBuilder
in interfaceEnumOrBuilder
-
getOptionsOrBuilderList
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsOrBuilderList
in interfaceEnumOrBuilder
-
addOptionsBuilder
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
addOptionsBuilder
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
getOptionsBuilderList
Protocol buffer options.
repeated .google.protobuf.Option options = 3;
-
getOptionsFieldBuilder
-
hasSourceContext
public boolean hasSourceContext()The source context.
.google.protobuf.SourceContext source_context = 4;
- Specified by:
hasSourceContext
in interfaceEnumOrBuilder
- Returns:
- Whether the sourceContext field is set.
-
getSourceContext
The source context.
.google.protobuf.SourceContext source_context = 4;
- Specified by:
getSourceContext
in interfaceEnumOrBuilder
- Returns:
- The sourceContext.
-
setSourceContext
The source context.
.google.protobuf.SourceContext source_context = 4;
-
setSourceContext
The source context.
.google.protobuf.SourceContext source_context = 4;
-
mergeSourceContext
The source context.
.google.protobuf.SourceContext source_context = 4;
-
clearSourceContext
The source context.
.google.protobuf.SourceContext source_context = 4;
-
getSourceContextBuilder
The source context.
.google.protobuf.SourceContext source_context = 4;
-
getSourceContextOrBuilder
The source context.
.google.protobuf.SourceContext source_context = 4;
- Specified by:
getSourceContextOrBuilder
in interfaceEnumOrBuilder
-
getSourceContextFieldBuilder
private SingleFieldBuilderV3<SourceContext,SourceContext.Builder, getSourceContextFieldBuilder()SourceContextOrBuilder> The source context.
.google.protobuf.SourceContext source_context = 4;
-
getSyntaxValue
public int getSyntaxValue()The source syntax.
.google.protobuf.Syntax syntax = 5;
- Specified by:
getSyntaxValue
in interfaceEnumOrBuilder
- Returns:
- The enum numeric value on the wire for syntax.
-
setSyntaxValue
The source syntax.
.google.protobuf.Syntax syntax = 5;
- 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 = 5;
- Specified by:
getSyntax
in interfaceEnumOrBuilder
- Returns:
- The syntax.
-
setSyntax
The source syntax.
.google.protobuf.Syntax syntax = 5;
- Parameters:
value
- The syntax to set.- Returns:
- This builder for chaining.
-
clearSyntax
The source syntax.
.google.protobuf.Syntax syntax = 5;
- 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<Enum.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<Enum.Builder>
-