Class Enum.Builder
- All Implemented Interfaces:
EnumOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable
- Enclosing class:
Enum
public static final class Enum.Builder
extends GeneratedMessage.Builder<Enum.Builder>
implements EnumOrBuilder
Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.Protobuf type
google.protobuf.Enum-
Nested Class Summary
Nested classes/interfaces inherited from class AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate intprivate Objectprivate Objectprivate RepeatedFieldBuilder<Option, Option.Builder, OptionOrBuilder> private SourceContextprivate int -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateBuilder()privateBuilder(AbstractMessage.BuilderParent parent) -
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.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.private voidbuildPartial0(Enum result) private voidbuildPartialRepeatedFields(Enum result) clear()Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.The source edition string, only valid when syntax is SYNTAX_EDITIONS.Enum value definitions.Enum type name.Protocol buffer options.The source context.The source syntax.private voidprivate voidGet an instance of the type with no fields set.static final Descriptors.DescriptorGet the message's type's descriptor.The source edition string, only valid when syntax is SYNTAX_EDITIONS.The source edition string, only valid when syntax is SYNTAX_EDITIONS.getEnumvalue(int index) Enum value definitions.getEnumvalueBuilder(int index) Enum value definitions.Enum value definitions.intEnum 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.intProtocol 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 syntax.intThe source syntax.booleanThe source context.protected GeneratedMessage.FieldAccessorTableGet the FieldAccessorTable for this type.private RepeatedFieldBuilder<Option, Option.Builder, OptionOrBuilder> The source context.final booleanReturns true if all required fields in the message and all embedded messages are set, false otherwise.private voidmergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) LikeMessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.Mergeotherinto the message being built.mergeSourceContext(SourceContext value) The source context.removeEnumvalue(int index) Enum value definitions.removeOptions(int index) Protocol buffer options.setEdition(String value) The source edition string, only valid when syntax is SYNTAX_EDITIONS.setEditionBytes(ByteString value) The source edition string, only valid when syntax is SYNTAX_EDITIONS.setEnumvalue(int index, EnumValue value) Enum value definitions.setEnumvalue(int index, EnumValue.Builder builderForValue) Enum value definitions.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.setSourceContext(SourceContext value) The source context.setSourceContext(SourceContext.Builder builderForValue) The source context.The source syntax.setSyntaxValue(int value) The source syntax.Methods inherited from class GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, dispose, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface MessageLite.Builder
mergeFromMethods inherited from interface 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 SingleFieldBuilder<SourceContext, SourceContext.Builder, SourceContextOrBuilder> sourceContextBuilder_ -
syntax_
private int syntax_ -
edition_
-
-
Constructor Details
-
Builder
private Builder() -
Builder
-
-
Method Details
-
getDescriptor
-
internalGetFieldAccessorTable
Description copied from class:GeneratedMessage.BuilderGet 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:
internalGetFieldAccessorTablein classGeneratedMessage.Builder<Enum.Builder>
-
maybeForceBuilderInitialization
private void maybeForceBuilderInitialization() -
clear
Description copied from class:GeneratedMessage.BuilderCalled by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.- Specified by:
clearin interfaceMessage.Builder- Specified by:
clearin interfaceMessageLite.Builder- Overrides:
clearin classGeneratedMessage.Builder<Enum.Builder>
-
getDescriptorForType
Description copied from interface:Message.BuilderGet the message's type's descriptor. SeeMessageOrBuilder.getDescriptorForType().- Specified by:
getDescriptorForTypein interfaceMessage.Builder- Specified by:
getDescriptorForTypein interfaceMessageOrBuilder- Overrides:
getDescriptorForTypein classGeneratedMessage.Builder<Enum.Builder>
-
getDefaultInstanceForType
Description copied from interface:MessageLiteOrBuilderGet 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 theMessageLiteinterface whereasgetDefaultInstance()is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForTypein interfaceMessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfaceMessageOrBuilder
-
build
Description copied from interface:MessageLite.BuilderConstructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.- Specified by:
buildin interfaceMessage.Builder- Specified by:
buildin interfaceMessageLite.Builder
-
buildPartial
Description copied from interface:MessageLite.BuilderLikeMessageLite.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:
buildPartialin interfaceMessage.Builder- Specified by:
buildPartialin interfaceMessageLite.Builder
-
buildPartialRepeatedFields
-
buildPartial0
-
mergeFrom
Description copied from interface:Message.BuilderMergeotherinto the message being built.othermust 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 inotherare 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::MergeFrommethod in C++.- Specified by:
mergeFromin interfaceMessage.Builder- Overrides:
mergeFromin classAbstractMessage.Builder<Enum.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()Description copied from interface:MessageLiteOrBuilderReturns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitializedin interfaceMessageLiteOrBuilder- Overrides:
isInitializedin classGeneratedMessage.Builder<Enum.Builder>
-
mergeFrom
public Enum.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException Description copied from interface:MessageLite.BuilderLikeMessageLite.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:
mergeFromin interfaceMessage.Builder- Specified by:
mergeFromin interfaceMessageLite.Builder- Overrides:
mergeFromin classAbstractMessage.Builder<Enum.Builder>- Throws:
IOException- an I/O error reading from the stream
-
getName
Enum type name.
string name = 1;- Specified by:
getNamein interfaceEnumOrBuilder- Returns:
- The name.
-
getNameBytes
Enum type name.
string name = 1;- Specified by:
getNameBytesin 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:
getEnumvalueListin interfaceEnumOrBuilder
-
getEnumvalueCount
public int getEnumvalueCount()Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;- Specified by:
getEnumvalueCountin interfaceEnumOrBuilder
-
getEnumvalue
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;- Specified by:
getEnumvaluein 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:
getEnumvalueOrBuilderin interfaceEnumOrBuilder
-
getEnumvalueOrBuilderList
Enum value definitions.
repeated .google.protobuf.EnumValue enumvalue = 2;- Specified by:
getEnumvalueOrBuilderListin 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; -
internalGetEnumvalueFieldBuilder
private RepeatedFieldBuilder<EnumValue, EnumValue.Builder, EnumValueOrBuilder> internalGetEnumvalueFieldBuilder() -
ensureOptionsIsMutable
private void ensureOptionsIsMutable() -
getOptionsList
Protocol buffer options.
repeated .google.protobuf.Option options = 3;- Specified by:
getOptionsListin interfaceEnumOrBuilder
-
getOptionsCount
public int getOptionsCount()Protocol buffer options.
repeated .google.protobuf.Option options = 3;- Specified by:
getOptionsCountin interfaceEnumOrBuilder
-
getOptions
Protocol buffer options.
repeated .google.protobuf.Option options = 3;- Specified by:
getOptionsin 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:
getOptionsOrBuilderin interfaceEnumOrBuilder
-
getOptionsOrBuilderList
Protocol buffer options.
repeated .google.protobuf.Option options = 3;- Specified by:
getOptionsOrBuilderListin 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; -
internalGetOptionsFieldBuilder
private RepeatedFieldBuilder<Option, Option.Builder, OptionOrBuilder> internalGetOptionsFieldBuilder() -
hasSourceContext
public boolean hasSourceContext()The source context.
.google.protobuf.SourceContext source_context = 4;- Specified by:
hasSourceContextin interfaceEnumOrBuilder- Returns:
- Whether the sourceContext field is set.
-
getSourceContext
The source context.
.google.protobuf.SourceContext source_context = 4;- Specified by:
getSourceContextin 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:
getSourceContextOrBuilderin interfaceEnumOrBuilder
-
internalGetSourceContextFieldBuilder
private SingleFieldBuilder<SourceContext, SourceContext.Builder, SourceContextOrBuilder> internalGetSourceContextFieldBuilder()The source context.
.google.protobuf.SourceContext source_context = 4; -
getSyntaxValue
public int getSyntaxValue()The source syntax.
.google.protobuf.Syntax syntax = 5;- Specified by:
getSyntaxValuein 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.
- Throws:
IllegalArgumentException- if UNRECOGNIZED is provided.
-
getSyntax
The source syntax.
.google.protobuf.Syntax syntax = 5;- Specified by:
getSyntaxin 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.
-
getEdition
The source edition string, only valid when syntax is SYNTAX_EDITIONS.
string edition = 6;- Specified by:
getEditionin interfaceEnumOrBuilder- Returns:
- The edition.
-
getEditionBytes
The source edition string, only valid when syntax is SYNTAX_EDITIONS.
string edition = 6;- Specified by:
getEditionBytesin interfaceEnumOrBuilder- Returns:
- The bytes for edition.
-
setEdition
The source edition string, only valid when syntax is SYNTAX_EDITIONS.
string edition = 6;- Parameters:
value- The edition to set.- Returns:
- This builder for chaining.
-
clearEdition
The source edition string, only valid when syntax is SYNTAX_EDITIONS.
string edition = 6;- Returns:
- This builder for chaining.
-
setEditionBytes
The source edition string, only valid when syntax is SYNTAX_EDITIONS.
string edition = 6;- Parameters:
value- The bytes for edition to set.- Returns:
- This builder for chaining.
-