Package com.google.protobuf
Class DescriptorProtos.FieldDescriptorProto.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<DescriptorProtos.FieldDescriptorProto,DescriptorProtos.FieldDescriptorProto.Builder>
com.google.protobuf.GeneratedMessageLite.Builder<DescriptorProtos.FieldDescriptorProto,DescriptorProtos.FieldDescriptorProto.Builder>
com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Builder
- All Implemented Interfaces:
DescriptorProtos.FieldDescriptorProtoOrBuilder
,MessageLite.Builder
,MessageLiteOrBuilder
,Cloneable
- Enclosing class:
DescriptorProtos.FieldDescriptorProto
public static final class DescriptorProtos.FieldDescriptorProto.Builder
extends GeneratedMessageLite.Builder<DescriptorProtos.FieldDescriptorProto,DescriptorProtos.FieldDescriptorProto.Builder>
implements DescriptorProtos.FieldDescriptorProtoOrBuilder
Describes a field within a message.Protobuf type
google.protobuf.FieldDescriptorProto
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream
-
Field Summary
Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
instance
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionFor numeric types, contains the original text representation of the value.For extensions, this is the name of the type being extended.JSON name of this field.optional .google.protobuf.FieldDescriptorProto.Label label = 4;
optional string name = 1;
optional int32 number = 3;
If set, gives the index of a oneof in the containing type's oneof_decl list.optional .google.protobuf.FieldOptions options = 8;
If true, this is a proto3 "optional".If type_name is set, this need not be set.For message and enum types, this is the name of the type.For numeric types, contains the original text representation of the value.For numeric types, contains the original text representation of the value.For extensions, this is the name of the type being extended.For extensions, this is the name of the type being extended.JSON name of this field.JSON name of this field.getLabel()
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
getName()
optional string name = 1;
optional string name = 1;
int
optional int32 number = 3;
int
If set, gives the index of a oneof in the containing type's oneof_decl list.optional .google.protobuf.FieldOptions options = 8;
boolean
If true, this is a proto3 "optional".getType()
If type_name is set, this need not be set.For message and enum types, this is the name of the type.For message and enum types, this is the name of the type.boolean
For numeric types, contains the original text representation of the value.boolean
For extensions, this is the name of the type being extended.boolean
JSON name of this field.boolean
hasLabel()
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
boolean
hasName()
optional string name = 1;
boolean
optional int32 number = 3;
boolean
If set, gives the index of a oneof in the containing type's oneof_decl list.boolean
optional .google.protobuf.FieldOptions options = 8;
boolean
If true, this is a proto3 "optional".boolean
hasType()
If type_name is set, this need not be set.boolean
For message and enum types, this is the name of the type.optional .google.protobuf.FieldOptions options = 8;
setDefaultValue
(String value) For numeric types, contains the original text representation of the value.setDefaultValueBytes
(ByteString value) For numeric types, contains the original text representation of the value.setExtendee
(String value) For extensions, this is the name of the type being extended.setExtendeeBytes
(ByteString value) For extensions, this is the name of the type being extended.setJsonName
(String value) JSON name of this field.setJsonNameBytes
(ByteString value) JSON name of this field.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) If set, gives the index of a oneof in the containing type's oneof_decl list.optional .google.protobuf.FieldOptions options = 8;
setOptions
(DescriptorProtos.FieldOptions.Builder builderForValue) optional .google.protobuf.FieldOptions options = 8;
setProto3Optional
(boolean value) If true, this is a proto3 "optional".If type_name is set, this need not be set.setTypeName
(String value) For message and enum types, this is the name of the type.setTypeNameBytes
(ByteString value) For message and enum types, this is the name of the type.Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFrom
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Constructor Details
-
Builder
private Builder()
-
-
Method Details
-
hasName
public boolean hasName()optional string name = 1;
- Specified by:
hasName
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- Whether the name field is set.
-
getName
optional string name = 1;
- Specified by:
getName
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The name.
-
getNameBytes
optional string name = 1;
- Specified by:
getNameBytes
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The bytes for name.
-
setName
optional string name = 1;
- Parameters:
value
- The name to set.- Returns:
- This builder for chaining.
-
clearName
optional string name = 1;
- Returns:
- This builder for chaining.
-
setNameBytes
optional string name = 1;
- Parameters:
value
- The bytes for name to set.- Returns:
- This builder for chaining.
-
hasNumber
public boolean hasNumber()optional int32 number = 3;
- Specified by:
hasNumber
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- Whether the number field is set.
-
getNumber
public int getNumber()optional int32 number = 3;
- Specified by:
getNumber
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The number.
-
setNumber
optional int32 number = 3;
- Parameters:
value
- The number to set.- Returns:
- This builder for chaining.
-
clearNumber
optional int32 number = 3;
- Returns:
- This builder for chaining.
-
hasLabel
public boolean hasLabel()optional .google.protobuf.FieldDescriptorProto.Label label = 4;
- Specified by:
hasLabel
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- Whether the label field is set.
-
getLabel
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
- Specified by:
getLabel
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The label.
-
setLabel
public DescriptorProtos.FieldDescriptorProto.Builder setLabel(DescriptorProtos.FieldDescriptorProto.Label value) optional .google.protobuf.FieldDescriptorProto.Label label = 4;
- Parameters:
value
- The enum numeric value on the wire for label to set.- Returns:
- This builder for chaining.
-
clearLabel
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
- Returns:
- This builder for chaining.
-
hasType
public boolean hasType()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.
optional .google.protobuf.FieldDescriptorProto.Type type = 5;
- Specified by:
hasType
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- Whether the type field is set.
-
getType
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.
optional .google.protobuf.FieldDescriptorProto.Type type = 5;
- Specified by:
getType
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The type.
-
setType
public DescriptorProtos.FieldDescriptorProto.Builder setType(DescriptorProtos.FieldDescriptorProto.Type value) 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.
optional .google.protobuf.FieldDescriptorProto.Type type = 5;
- Parameters:
value
- The enum numeric value on the wire for type to set.- Returns:
- This builder for chaining.
-
clearType
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.
optional .google.protobuf.FieldDescriptorProto.Type type = 5;
- Returns:
- This builder for chaining.
-
hasTypeName
public boolean hasTypeName()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).
optional string type_name = 6;
- Specified by:
hasTypeName
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- Whether the typeName field is set.
-
getTypeName
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).
optional string type_name = 6;
- Specified by:
getTypeName
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The typeName.
-
getTypeNameBytes
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).
optional string type_name = 6;
- Specified by:
getTypeNameBytes
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The bytes for typeName.
-
setTypeName
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).
optional string type_name = 6;
- Parameters:
value
- The typeName to set.- Returns:
- This builder for chaining.
-
clearTypeName
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).
optional string type_name = 6;
- Returns:
- This builder for chaining.
-
setTypeNameBytes
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).
optional string type_name = 6;
- Parameters:
value
- The bytes for typeName to set.- Returns:
- This builder for chaining.
-
hasExtendee
public boolean hasExtendee()For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
optional string extendee = 2;
- Specified by:
hasExtendee
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- Whether the extendee field is set.
-
getExtendee
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
optional string extendee = 2;
- Specified by:
getExtendee
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The extendee.
-
getExtendeeBytes
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
optional string extendee = 2;
- Specified by:
getExtendeeBytes
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The bytes for extendee.
-
setExtendee
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
optional string extendee = 2;
- Parameters:
value
- The extendee to set.- Returns:
- This builder for chaining.
-
clearExtendee
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
optional string extendee = 2;
- Returns:
- This builder for chaining.
-
setExtendeeBytes
For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.
optional string extendee = 2;
- Parameters:
value
- The bytes for extendee to set.- Returns:
- This builder for chaining.
-
hasDefaultValue
public boolean hasDefaultValue()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.
optional string default_value = 7;
- Specified by:
hasDefaultValue
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- Whether the defaultValue field is set.
-
getDefaultValue
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.
optional string default_value = 7;
- Specified by:
getDefaultValue
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The defaultValue.
-
getDefaultValueBytes
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.
optional string default_value = 7;
- Specified by:
getDefaultValueBytes
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The bytes for defaultValue.
-
setDefaultValue
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.
optional string default_value = 7;
- Parameters:
value
- The defaultValue to set.- Returns:
- This builder for chaining.
-
clearDefaultValue
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.
optional string default_value = 7;
- Returns:
- This builder for chaining.
-
setDefaultValueBytes
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.
optional string default_value = 7;
- Parameters:
value
- The bytes for defaultValue to set.- Returns:
- This builder for chaining.
-
hasOneofIndex
public boolean hasOneofIndex()If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
optional int32 oneof_index = 9;
- Specified by:
hasOneofIndex
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- Whether the oneofIndex field is set.
-
getOneofIndex
public int getOneofIndex()If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
optional int32 oneof_index = 9;
- Specified by:
getOneofIndex
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The oneofIndex.
-
setOneofIndex
If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
optional int32 oneof_index = 9;
- Parameters:
value
- The oneofIndex to set.- Returns:
- This builder for chaining.
-
clearOneofIndex
If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
optional int32 oneof_index = 9;
- Returns:
- This builder for chaining.
-
hasJsonName
public boolean hasJsonName()JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
optional string json_name = 10;
- Specified by:
hasJsonName
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- Whether the jsonName field is set.
-
getJsonName
JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
optional string json_name = 10;
- Specified by:
getJsonName
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The jsonName.
-
getJsonNameBytes
JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
optional string json_name = 10;
- Specified by:
getJsonNameBytes
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The bytes for jsonName.
-
setJsonName
JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
optional string json_name = 10;
- Parameters:
value
- The jsonName to set.- Returns:
- This builder for chaining.
-
clearJsonName
JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
optional string json_name = 10;
- Returns:
- This builder for chaining.
-
setJsonNameBytes
JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
optional string json_name = 10;
- Parameters:
value
- The bytes for jsonName to set.- Returns:
- This builder for chaining.
-
hasOptions
public boolean hasOptions()optional .google.protobuf.FieldOptions options = 8;
- Specified by:
hasOptions
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- Whether the options field is set.
-
getOptions
optional .google.protobuf.FieldOptions options = 8;
- Specified by:
getOptions
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The options.
-
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;
-
hasProto3Optional
public boolean hasProto3Optional()If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with `LABEL_OPTIONAL`.
optional bool proto3_optional = 17;
- Specified by:
hasProto3Optional
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- Whether the proto3Optional field is set.
-
getProto3Optional
public boolean getProto3Optional()If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with `LABEL_OPTIONAL`.
optional bool proto3_optional = 17;
- Specified by:
getProto3Optional
in interfaceDescriptorProtos.FieldDescriptorProtoOrBuilder
- Returns:
- The proto3Optional.
-
setProto3Optional
If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with `LABEL_OPTIONAL`.
optional bool proto3_optional = 17;
- Parameters:
value
- The proto3Optional to set.- Returns:
- This builder for chaining.
-
clearProto3Optional
If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with `LABEL_OPTIONAL`.
optional bool proto3_optional = 17;
- Returns:
- This builder for chaining.
-