Package com.google.protobuf.gen
Interface DescriptorProtos.FieldDescriptorProtoOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
DescriptorProtos.FieldDescriptorProto,DescriptorProtos.FieldDescriptorProto.Builder
- Enclosing class:
- DescriptorProtos
public static interface DescriptorProtos.FieldDescriptorProtoOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDefaultValue()For numeric types, contains the original text representation of the value.com.google.protobuf.ByteStringgetDefaultValueBytes()For numeric types, contains the original text representation of the value.StringgetExtendee()For extensions, this is the name of the type being extended.com.google.protobuf.ByteStringgetExtendeeBytes()For extensions, this is the name of the type being extended.StringgetJsonName()JSON name of this field.com.google.protobuf.ByteStringgetJsonNameBytes()JSON name of this field.DescriptorProtos.FieldDescriptorProto.LabelgetLabel()optional .google.protobuf.FieldDescriptorProto.Label label = 4;StringgetName()optional string name = 1;com.google.protobuf.ByteStringgetNameBytes()optional string name = 1;intgetNumber()optional int32 number = 3;intgetOneofIndex()If set, gives the index of a oneof in the containing type's oneof_decl list.DescriptorProtos.FieldOptionsgetOptions()optional .google.protobuf.FieldOptions options = 8;DescriptorProtos.FieldOptionsOrBuildergetOptionsOrBuilder()optional .google.protobuf.FieldOptions options = 8;booleangetProto3Optional()If true, this is a proto3 "optional".DescriptorProtos.FieldDescriptorProto.TypegetType()If type_name is set, this need not be set.StringgetTypeName()For message and enum types, this is the name of the type.com.google.protobuf.ByteStringgetTypeNameBytes()For message and enum types, this is the name of the type.booleanhasDefaultValue()For numeric types, contains the original text representation of the value.booleanhasExtendee()For extensions, this is the name of the type being extended.booleanhasJsonName()JSON name of this field.booleanhasLabel()optional .google.protobuf.FieldDescriptorProto.Label label = 4;booleanhasName()optional string name = 1;booleanhasNumber()optional int32 number = 3;booleanhasOneofIndex()If set, gives the index of a oneof in the containing type's oneof_decl list.booleanhasOptions()optional .google.protobuf.FieldOptions options = 8;booleanhasProto3Optional()If true, this is a proto3 "optional".booleanhasType()If type_name is set, this need not be set.booleanhasTypeName()For message and enum types, this is the name of the type.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
hasName
boolean hasName()
optional string name = 1;
-
getName
String getName()
optional string name = 1;
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()
optional string name = 1;
-
hasNumber
boolean hasNumber()
optional int32 number = 3;
-
getNumber
int getNumber()
optional int32 number = 3;
-
hasLabel
boolean hasLabel()
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
-
getLabel
DescriptorProtos.FieldDescriptorProto.Label getLabel()
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
-
hasType
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;
-
getType
DescriptorProtos.FieldDescriptorProto.Type 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;
-
hasTypeName
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;
-
getTypeName
String 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;
-
getTypeNameBytes
com.google.protobuf.ByteString 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;
-
hasExtendee
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;
-
getExtendee
String 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;
-
getExtendeeBytes
com.google.protobuf.ByteString 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;
-
hasDefaultValue
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. TODO(kenton): Base-64 encode?
optional string default_value = 7;
-
getDefaultValue
String 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. TODO(kenton): Base-64 encode?
optional string default_value = 7;
-
getDefaultValueBytes
com.google.protobuf.ByteString 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. TODO(kenton): Base-64 encode?
optional string default_value = 7;
-
hasOneofIndex
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;
-
getOneofIndex
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;
-
hasJsonName
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;
-
getJsonName
String 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;
-
getJsonNameBytes
com.google.protobuf.ByteString 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;
-
hasOptions
boolean hasOptions()
optional .google.protobuf.FieldOptions options = 8;
-
getOptions
DescriptorProtos.FieldOptions getOptions()
optional .google.protobuf.FieldOptions options = 8;
-
getOptionsOrBuilder
DescriptorProtos.FieldOptionsOrBuilder getOptionsOrBuilder()
optional .google.protobuf.FieldOptions options = 8;
-
hasProto3Optional
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 be 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;
-
getProto3Optional
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 be 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;
-
-