Package com.google.protobuf
Class Field.Builder
java.lang.Object
- All Implemented Interfaces:
FieldOrBuilder,Message.Builder,MessageLite.Builder,MessageLiteOrBuilder,MessageOrBuilder,Cloneable
- Enclosing class:
- Field
public static final class Field.Builder
extends GeneratedMessageV3.Builder<Field.Builder>
implements FieldOrBuilder
Protobuf type
google.protobuf.Field-
Method Summary
Modifier and TypeMethodDescriptionaddAllOptions(Iterable<? extends Option> values) repeated .google.protobuf.Option options = 9 [json_name = "options"];addOptions(int index, Option value) repeated .google.protobuf.Option options = 9 [json_name = "options"];addOptions(int index, Option.Builder builderForValue) repeated .google.protobuf.Option options = 9 [json_name = "options"];addOptions(Option value) repeated .google.protobuf.Option options = 9 [json_name = "options"];addOptions(Option.Builder builderForValue) repeated .google.protobuf.Option options = 9 [json_name = "options"];repeated .google.protobuf.Option options = 9 [json_name = "options"];addOptionsBuilder(int index) repeated .google.protobuf.Option options = 9 [json_name = "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.clear()Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values..google.protobuf.Field.Cardinality cardinality = 2 [json_name = "cardinality"];string default_value = 11 [json_name = "defaultValue"];string json_name = 10 [json_name = "jsonName"];.google.protobuf.Field.Kind kind = 1 [json_name = "kind"];string name = 4 [json_name = "name"];int32 number = 3 [json_name = "number"];int32 oneof_index = 7 [json_name = "oneofIndex"];repeated .google.protobuf.Option options = 9 [json_name = "options"];bool packed = 8 [json_name = "packed"];string type_url = 6 [json_name = "typeUrl"];.google.protobuf.Field.Cardinality cardinality = 2 [json_name = "cardinality"];int.google.protobuf.Field.Cardinality cardinality = 2 [json_name = "cardinality"];Get an instance of the type with no fields set.string default_value = 11 [json_name = "defaultValue"];string default_value = 11 [json_name = "defaultValue"];static final Descriptors.DescriptorGet the message's type's descriptor.string json_name = 10 [json_name = "jsonName"];string json_name = 10 [json_name = "jsonName"];getKind().google.protobuf.Field.Kind kind = 1 [json_name = "kind"];int.google.protobuf.Field.Kind kind = 1 [json_name = "kind"];getName()string name = 4 [json_name = "name"];string name = 4 [json_name = "name"];intint32 number = 3 [json_name = "number"];intint32 oneof_index = 7 [json_name = "oneofIndex"];getOptions(int index) repeated .google.protobuf.Option options = 9 [json_name = "options"];getOptionsBuilder(int index) repeated .google.protobuf.Option options = 9 [json_name = "options"];repeated .google.protobuf.Option options = 9 [json_name = "options"];intrepeated .google.protobuf.Option options = 9 [json_name = "options"];repeated .google.protobuf.Option options = 9 [json_name = "options"];getOptionsOrBuilder(int index) repeated .google.protobuf.Option options = 9 [json_name = "options"];List<? extends OptionOrBuilder>repeated .google.protobuf.Option options = 9 [json_name = "options"];booleanbool packed = 8 [json_name = "packed"];string type_url = 6 [json_name = "typeUrl"];string type_url = 6 [json_name = "typeUrl"];protected GeneratedMessageV3.FieldAccessorTableGet the FieldAccessorTable for this type.final booleanReturns 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.Mergeotherinto the message being built.final Field.BuildermergeUnknownFields(UnknownFieldSet unknownFields) Merge some unknown fields into theUnknownFieldSetfor this message.removeOptions(int index) repeated .google.protobuf.Option options = 9 [json_name = "options"];setCardinality(Field.Cardinality value) .google.protobuf.Field.Cardinality cardinality = 2 [json_name = "cardinality"];setCardinalityValue(int value) .google.protobuf.Field.Cardinality cardinality = 2 [json_name = "cardinality"];setDefaultValue(String value) string default_value = 11 [json_name = "defaultValue"];setDefaultValueBytes(ByteString value) string default_value = 11 [json_name = "defaultValue"];setJsonName(String value) string json_name = 10 [json_name = "jsonName"];setJsonNameBytes(ByteString value) string json_name = 10 [json_name = "jsonName"];setKind(Field.Kind value) .google.protobuf.Field.Kind kind = 1 [json_name = "kind"];setKindValue(int value) .google.protobuf.Field.Kind kind = 1 [json_name = "kind"];string name = 4 [json_name = "name"];setNameBytes(ByteString value) string name = 4 [json_name = "name"];setNumber(int value) int32 number = 3 [json_name = "number"];setOneofIndex(int value) int32 oneof_index = 7 [json_name = "oneofIndex"];setOptions(int index, Option value) repeated .google.protobuf.Option options = 9 [json_name = "options"];setOptions(int index, Option.Builder builderForValue) repeated .google.protobuf.Option options = 9 [json_name = "options"];setPacked(boolean value) bool packed = 8 [json_name = "packed"];setTypeUrl(String value) string type_url = 6 [json_name = "typeUrl"];setTypeUrlBytes(ByteString value) string type_url = 6 [json_name = "typeUrl"];final Field.BuildersetUnknownFields(UnknownFieldSet unknownFields) Set theUnknownFieldSetfor this message.Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
-
internalGetFieldAccessorTable
Description copied from class:GeneratedMessageV3.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 classGeneratedMessageV3.Builder<Field.Builder>
-
clear
Description copied from class:GeneratedMessageV3.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 classGeneratedMessageV3.Builder<Field.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 classGeneratedMessageV3.Builder<Field.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
-
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<Field.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 classGeneratedMessageV3.Builder<Field.Builder>
-
mergeFrom
public Field.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<Field.Builder>- Throws:
InvalidProtocolBufferException- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.IOException- an I/O error reading from the stream
-
getKindValue
public int getKindValue().google.protobuf.Field.Kind kind = 1 [json_name = "kind"];- Specified by:
getKindValuein interfaceFieldOrBuilder- Returns:
- The enum numeric value on the wire for kind.
-
setKindValue
.google.protobuf.Field.Kind kind = 1 [json_name = "kind"];- Parameters:
value- The enum numeric value on the wire for kind to set.- Returns:
- This builder for chaining.
-
getKind
.google.protobuf.Field.Kind kind = 1 [json_name = "kind"];- Specified by:
getKindin interfaceFieldOrBuilder- Returns:
- The kind.
-
setKind
.google.protobuf.Field.Kind kind = 1 [json_name = "kind"];- Parameters:
value- The kind to set.- Returns:
- This builder for chaining.
-
clearKind
.google.protobuf.Field.Kind kind = 1 [json_name = "kind"];- Returns:
- This builder for chaining.
-
getCardinalityValue
public int getCardinalityValue().google.protobuf.Field.Cardinality cardinality = 2 [json_name = "cardinality"];- Specified by:
getCardinalityValuein interfaceFieldOrBuilder- Returns:
- The enum numeric value on the wire for cardinality.
-
setCardinalityValue
.google.protobuf.Field.Cardinality cardinality = 2 [json_name = "cardinality"];- Parameters:
value- The enum numeric value on the wire for cardinality to set.- Returns:
- This builder for chaining.
-
getCardinality
.google.protobuf.Field.Cardinality cardinality = 2 [json_name = "cardinality"];- Specified by:
getCardinalityin interfaceFieldOrBuilder- Returns:
- The cardinality.
-
setCardinality
.google.protobuf.Field.Cardinality cardinality = 2 [json_name = "cardinality"];- Parameters:
value- The cardinality to set.- Returns:
- This builder for chaining.
-
clearCardinality
.google.protobuf.Field.Cardinality cardinality = 2 [json_name = "cardinality"];- Returns:
- This builder for chaining.
-
getNumber
public int getNumber()int32 number = 3 [json_name = "number"];- Specified by:
getNumberin interfaceFieldOrBuilder- Returns:
- The number.
-
setNumber
int32 number = 3 [json_name = "number"];- Parameters:
value- The number to set.- Returns:
- This builder for chaining.
-
clearNumber
int32 number = 3 [json_name = "number"];- Returns:
- This builder for chaining.
-
getName
string name = 4 [json_name = "name"];- Specified by:
getNamein interfaceFieldOrBuilder- Returns:
- The name.
-
getNameBytes
string name = 4 [json_name = "name"];- Specified by:
getNameBytesin interfaceFieldOrBuilder- Returns:
- The bytes for name.
-
setName
string name = 4 [json_name = "name"];- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
string name = 4 [json_name = "name"];- Returns:
- This builder for chaining.
-
setNameBytes
string name = 4 [json_name = "name"];- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
getTypeUrl
string type_url = 6 [json_name = "typeUrl"];- Specified by:
getTypeUrlin interfaceFieldOrBuilder- Returns:
- The typeUrl.
-
getTypeUrlBytes
string type_url = 6 [json_name = "typeUrl"];- Specified by:
getTypeUrlBytesin interfaceFieldOrBuilder- Returns:
- The bytes for typeUrl.
-
setTypeUrl
string type_url = 6 [json_name = "typeUrl"];- Parameters:
value- The typeUrl to set.- Returns:
- This builder for chaining.
-
clearTypeUrl
string type_url = 6 [json_name = "typeUrl"];- Returns:
- This builder for chaining.
-
setTypeUrlBytes
string type_url = 6 [json_name = "typeUrl"];- Parameters:
value- The bytes for typeUrl to set.- Returns:
- This builder for chaining.
-
getOneofIndex
public int getOneofIndex()int32 oneof_index = 7 [json_name = "oneofIndex"];- Specified by:
getOneofIndexin interfaceFieldOrBuilder- Returns:
- The oneofIndex.
-
setOneofIndex
int32 oneof_index = 7 [json_name = "oneofIndex"];- Parameters:
value- The oneofIndex to set.- Returns:
- This builder for chaining.
-
clearOneofIndex
int32 oneof_index = 7 [json_name = "oneofIndex"];- Returns:
- This builder for chaining.
-
getPacked
public boolean getPacked()bool packed = 8 [json_name = "packed"];- Specified by:
getPackedin interfaceFieldOrBuilder- Returns:
- The packed.
-
setPacked
bool packed = 8 [json_name = "packed"];- Parameters:
value- The packed to set.- Returns:
- This builder for chaining.
-
clearPacked
bool packed = 8 [json_name = "packed"];- Returns:
- This builder for chaining.
-
getOptionsList
repeated .google.protobuf.Option options = 9 [json_name = "options"];- Specified by:
getOptionsListin interfaceFieldOrBuilder
-
getOptionsCount
public int getOptionsCount()repeated .google.protobuf.Option options = 9 [json_name = "options"];- Specified by:
getOptionsCountin interfaceFieldOrBuilder
-
getOptions
repeated .google.protobuf.Option options = 9 [json_name = "options"];- Specified by:
getOptionsin interfaceFieldOrBuilder
-
setOptions
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
setOptions
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
addOptions
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
addOptions
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
addOptions
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
addOptions
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
addAllOptions
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
clearOptions
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
removeOptions
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
getOptionsBuilder
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
getOptionsOrBuilder
repeated .google.protobuf.Option options = 9 [json_name = "options"];- Specified by:
getOptionsOrBuilderin interfaceFieldOrBuilder
-
getOptionsOrBuilderList
repeated .google.protobuf.Option options = 9 [json_name = "options"];- Specified by:
getOptionsOrBuilderListin interfaceFieldOrBuilder
-
addOptionsBuilder
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
addOptionsBuilder
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
getOptionsBuilderList
repeated .google.protobuf.Option options = 9 [json_name = "options"]; -
getJsonName
string json_name = 10 [json_name = "jsonName"];- Specified by:
getJsonNamein interfaceFieldOrBuilder- Returns:
- The jsonName.
-
getJsonNameBytes
string json_name = 10 [json_name = "jsonName"];- Specified by:
getJsonNameBytesin interfaceFieldOrBuilder- Returns:
- The bytes for jsonName.
-
setJsonName
string json_name = 10 [json_name = "jsonName"];- Parameters:
value- The jsonName to set.- Returns:
- This builder for chaining.
-
clearJsonName
string json_name = 10 [json_name = "jsonName"];- Returns:
- This builder for chaining.
-
setJsonNameBytes
string json_name = 10 [json_name = "jsonName"];- Parameters:
value- The bytes for jsonName to set.- Returns:
- This builder for chaining.
-
getDefaultValue
string default_value = 11 [json_name = "defaultValue"];- Specified by:
getDefaultValuein interfaceFieldOrBuilder- Returns:
- The defaultValue.
-
getDefaultValueBytes
string default_value = 11 [json_name = "defaultValue"];- Specified by:
getDefaultValueBytesin interfaceFieldOrBuilder- Returns:
- The bytes for defaultValue.
-
setDefaultValue
string default_value = 11 [json_name = "defaultValue"];- Parameters:
value- The defaultValue to set.- Returns:
- This builder for chaining.
-
clearDefaultValue
string default_value = 11 [json_name = "defaultValue"];- Returns:
- This builder for chaining.
-
setDefaultValueBytes
string default_value = 11 [json_name = "defaultValue"];- Parameters:
value- The bytes for defaultValue to set.- Returns:
- This builder for chaining.
-
setUnknownFields
Description copied from interface:Message.BuilderSet theUnknownFieldSetfor this message.- Specified by:
setUnknownFieldsin interfaceMessage.Builder- Overrides:
setUnknownFieldsin classGeneratedMessageV3.Builder<Field.Builder>
-
mergeUnknownFields
Description copied from interface:Message.BuilderMerge some unknown fields into theUnknownFieldSetfor this message.- Specified by:
mergeUnknownFieldsin interfaceMessage.Builder- Overrides:
mergeUnknownFieldsin classGeneratedMessageV3.Builder<Field.Builder>
-