Package com.google.protobuf
Class DescriptorProtos.FieldDescriptorProto.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<BuilderType>
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessage.Builder<DescriptorProtos.FieldDescriptorProto.Builder>
com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Builder
- All Implemented Interfaces:
DescriptorProtos.FieldDescriptorProtoOrBuilder,Message.Builder,MessageLite.Builder,MessageLiteOrBuilder,MessageOrBuilder,Cloneable
- Enclosing class:
- DescriptorProtos.FieldDescriptorProto
public static final class DescriptorProtos.FieldDescriptorProto.Builder
extends GeneratedMessage.Builder<DescriptorProtos.FieldDescriptorProto.Builder>
implements DescriptorProtos.FieldDescriptorProtoOrBuilder
Protobuf type
google.protobuf.FieldDescriptorProto
Describes a field within a message.
-
Method Summary
Modifier and TypeMethodDescriptionbuild()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.optional string default_value = 7;optional string extendee = 2;optional .google.protobuf.FieldDescriptorProto.Label label = 4;optional string name = 1;optional int32 number = 3;optional int32 oneof_index = 9;optional .google.protobuf.FieldOptions options = 8;optional .google.protobuf.FieldDescriptorProto.Type type = 5;optional string type_name = 6;clone()Clones the Builder.Get an instance of the type with no fields set.optional string default_value = 7;optional string default_value = 7;static final Descriptors.DescriptorGet the message's type's descriptor.optional string extendee = 2;optional string extendee = 2;getLabel()optional .google.protobuf.FieldDescriptorProto.Label label = 4;getName()optional string name = 1;optional string name = 1;intoptional int32 number = 3;intoptional int32 oneof_index = 9;optional .google.protobuf.FieldOptions options = 8;optional .google.protobuf.FieldOptions options = 8;optional .google.protobuf.FieldOptions options = 8;getType()optional .google.protobuf.FieldDescriptorProto.Type type = 5;optional string type_name = 6;optional string type_name = 6;booleanoptional string default_value = 7;booleanoptional string extendee = 2;booleanhasLabel()optional .google.protobuf.FieldDescriptorProto.Label label = 4;booleanhasName()optional string name = 1;booleanoptional int32 number = 3;booleanoptional int32 oneof_index = 9;booleanoptional .google.protobuf.FieldOptions options = 8;booleanhasType()optional .google.protobuf.FieldDescriptorProto.Type type = 5;booleanoptional string type_name = 6;protected GeneratedMessage.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.optional .google.protobuf.FieldOptions options = 8;setDefaultValue(String value) optional string default_value = 7;setDefaultValueBytes(ByteString value) optional string default_value = 7;setExtendee(String value) optional string extendee = 2;setExtendeeBytes(ByteString value) optional string extendee = 2;optional .google.protobuf.FieldDescriptorProto.Label label = 4;optional string name = 1;setNameBytes(ByteString value) optional string name = 1;setNumber(int value) optional int32 number = 3;setOneofIndex(int value) optional int32 oneof_index = 9;optional .google.protobuf.FieldOptions options = 8;setOptions(DescriptorProtos.FieldOptions.Builder builderForValue) optional .google.protobuf.FieldOptions options = 8;optional .google.protobuf.FieldDescriptorProto.Type type = 5;setTypeName(String value) optional string type_name = 6;setTypeNameBytes(ByteString value) optional string type_name = 6;Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, mergeUnknownFields, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFieldsMethods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods 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: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<DescriptorProtos.FieldDescriptorProto.Builder>
-
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<DescriptorProtos.FieldDescriptorProto.Builder>
-
clone
Description copied from interface:MessageLite.BuilderClones the Builder.- Specified by:
clonein interfaceMessage.Builder- Specified by:
clonein interfaceMessageLite.Builder- Overrides:
clonein classGeneratedMessage.Builder<DescriptorProtos.FieldDescriptorProto.Builder>- See Also:
-
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<DescriptorProtos.FieldDescriptorProto.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. This is equivalent to theMessage::MergeFrommethod in C++.- Specified by:
mergeFromin interfaceMessage.Builder- Overrides:
mergeFromin classAbstractMessage.Builder<DescriptorProtos.FieldDescriptorProto.Builder>
-
mergeFrom
public DescriptorProtos.FieldDescriptorProto.Builder mergeFrom(DescriptorProtos.FieldDescriptorProto other) -
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<DescriptorProtos.FieldDescriptorProto.Builder>
-
mergeFrom
public DescriptorProtos.FieldDescriptorProto.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<DescriptorProtos.FieldDescriptorProto.Builder>- Throws:
IOException
-
hasName
public boolean hasName()optional string name = 1;- Specified by:
hasNamein interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getName
optional string name = 1;- Specified by:
getNamein interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getNameBytes
optional string name = 1;- Specified by:
getNameBytesin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
setName
optional string name = 1; -
clearName
optional string name = 1; -
setNameBytes
optional string name = 1; -
hasNumber
public boolean hasNumber()optional int32 number = 3;- Specified by:
hasNumberin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getNumber
public int getNumber()optional int32 number = 3;- Specified by:
getNumberin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
setNumber
optional int32 number = 3; -
clearNumber
optional int32 number = 3; -
hasLabel
public boolean hasLabel()optional .google.protobuf.FieldDescriptorProto.Label label = 4;- Specified by:
hasLabelin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getLabel
optional .google.protobuf.FieldDescriptorProto.Label label = 4;- Specified by:
getLabelin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
setLabel
public DescriptorProtos.FieldDescriptorProto.Builder setLabel(DescriptorProtos.FieldDescriptorProto.Label value) optional .google.protobuf.FieldDescriptorProto.Label label = 4; -
clearLabel
optional .google.protobuf.FieldDescriptorProto.Label label = 4; -
hasType
public boolean hasType()optional .google.protobuf.FieldDescriptorProto.Type type = 5;If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
- Specified by:
hasTypein interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getType
optional .google.protobuf.FieldDescriptorProto.Type type = 5;If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
- Specified by:
getTypein interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
setType
public DescriptorProtos.FieldDescriptorProto.Builder setType(DescriptorProtos.FieldDescriptorProto.Type value) optional .google.protobuf.FieldDescriptorProto.Type type = 5;If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
-
clearType
optional .google.protobuf.FieldDescriptorProto.Type type = 5;If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
-
hasTypeName
public boolean hasTypeName()optional string type_name = 6;For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
- Specified by:
hasTypeNamein interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getTypeName
optional string type_name = 6;For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
- Specified by:
getTypeNamein interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getTypeNameBytes
optional string type_name = 6;For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
- Specified by:
getTypeNameBytesin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
setTypeName
optional string type_name = 6;For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
-
clearTypeName
optional string type_name = 6;For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
-
setTypeNameBytes
optional string type_name = 6;For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
-
hasExtendee
public boolean hasExtendee()optional string extendee = 2;For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
- Specified by:
hasExtendeein interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getExtendee
optional string extendee = 2;For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
- Specified by:
getExtendeein interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getExtendeeBytes
optional string extendee = 2;For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
- Specified by:
getExtendeeBytesin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
setExtendee
optional string extendee = 2;For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
-
clearExtendee
optional string extendee = 2;For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
-
setExtendeeBytes
optional string extendee = 2;For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
-
hasDefaultValue
public boolean hasDefaultValue()optional string default_value = 7;For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. TODO(kenton): Base-64 encode?
- Specified by:
hasDefaultValuein interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getDefaultValue
optional string default_value = 7;For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. TODO(kenton): Base-64 encode?
- Specified by:
getDefaultValuein interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getDefaultValueBytes
optional string default_value = 7;For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. TODO(kenton): Base-64 encode?
- Specified by:
getDefaultValueBytesin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
setDefaultValue
optional string default_value = 7;For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. TODO(kenton): Base-64 encode?
-
clearDefaultValue
optional string default_value = 7;For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. TODO(kenton): Base-64 encode?
-
setDefaultValueBytes
optional string default_value = 7;For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped. TODO(kenton): Base-64 encode?
-
hasOneofIndex
public boolean hasOneofIndex()optional int32 oneof_index = 9;If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. Extensions of a oneof should not set this since the oneof to which they belong will be inferred based on the extension range containing the extension's field number.
- Specified by:
hasOneofIndexin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getOneofIndex
public int getOneofIndex()optional int32 oneof_index = 9;If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. Extensions of a oneof should not set this since the oneof to which they belong will be inferred based on the extension range containing the extension's field number.
- Specified by:
getOneofIndexin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
setOneofIndex
optional int32 oneof_index = 9;If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. Extensions of a oneof should not set this since the oneof to which they belong will be inferred based on the extension range containing the extension's field number.
-
clearOneofIndex
optional int32 oneof_index = 9;If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof. Extensions of a oneof should not set this since the oneof to which they belong will be inferred based on the extension range containing the extension's field number.
-
hasOptions
public boolean hasOptions()optional .google.protobuf.FieldOptions options = 8;- Specified by:
hasOptionsin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
getOptions
optional .google.protobuf.FieldOptions options = 8;- Specified by:
getOptionsin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-
setOptions
public DescriptorProtos.FieldDescriptorProto.Builder setOptions(DescriptorProtos.FieldOptions value) optional .google.protobuf.FieldOptions options = 8; -
setOptions
public DescriptorProtos.FieldDescriptorProto.Builder setOptions(DescriptorProtos.FieldOptions.Builder builderForValue) optional .google.protobuf.FieldOptions options = 8; -
mergeOptions
public DescriptorProtos.FieldDescriptorProto.Builder mergeOptions(DescriptorProtos.FieldOptions value) optional .google.protobuf.FieldOptions options = 8; -
clearOptions
optional .google.protobuf.FieldOptions options = 8; -
getOptionsBuilder
optional .google.protobuf.FieldOptions options = 8; -
getOptionsOrBuilder
optional .google.protobuf.FieldOptions options = 8;- Specified by:
getOptionsOrBuilderin interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
-