Package com.google.protobuf
Interface DescriptorProtos.FieldDescriptorProtoOrBuilder
-
- All Superinterfaces:
MessageLiteOrBuilder
,MessageOrBuilder
- All Known Implementing Classes:
DescriptorProtos.FieldDescriptorProto
,DescriptorProtos.FieldDescriptorProto.Builder
- Enclosing class:
- DescriptorProtos
public static interface DescriptorProtos.FieldDescriptorProtoOrBuilder extends MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDefaultValue()
For numeric types, contains the original text representation of the value.ByteString
getDefaultValueBytes()
For numeric types, contains the original text representation of the value.java.lang.String
getExtendee()
For extensions, this is the name of the type being extended.ByteString
getExtendeeBytes()
For extensions, this is the name of the type being extended.java.lang.String
getJsonName()
JSON name of this field.ByteString
getJsonNameBytes()
JSON name of this field.DescriptorProtos.FieldDescriptorProto.Label
getLabel()
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
java.lang.String
getName()
optional string name = 1;
ByteString
getNameBytes()
optional string name = 1;
int
getNumber()
optional int32 number = 3;
int
getOneofIndex()
If set, gives the index of a oneof in the containing type's oneof_decl list.DescriptorProtos.FieldOptions
getOptions()
optional .google.protobuf.FieldOptions options = 8;
DescriptorProtos.FieldOptionsOrBuilder
getOptionsOrBuilder()
optional .google.protobuf.FieldOptions options = 8;
boolean
getProto3Optional()
If true, this is a proto3 "optional".DescriptorProtos.FieldDescriptorProto.Type
getType()
If type_name is set, this need not be set.java.lang.String
getTypeName()
For message and enum types, this is the name of the type.ByteString
getTypeNameBytes()
For message and enum types, this is the name of the type.boolean
hasDefaultValue()
For numeric types, contains the original text representation of the value.boolean
hasExtendee()
For extensions, this is the name of the type being extended.boolean
hasJsonName()
JSON name of this field.boolean
hasLabel()
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
boolean
hasName()
optional string name = 1;
boolean
hasNumber()
optional int32 number = 3;
boolean
hasOneofIndex()
If set, gives the index of a oneof in the containing type's oneof_decl list.boolean
hasOptions()
optional .google.protobuf.FieldOptions options = 8;
boolean
hasProto3Optional()
If true, this is a proto3 "optional".boolean
hasType()
If type_name is set, this need not be set.boolean
hasTypeName()
For message and enum types, this is the name of the type.-
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
-
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;
- Returns:
- Whether the name field is set.
-
getName
java.lang.String getName()
optional string name = 1;
- Returns:
- The name.
-
getNameBytes
ByteString getNameBytes()
optional string name = 1;
- Returns:
- The bytes for name.
-
hasNumber
boolean hasNumber()
optional int32 number = 3;
- Returns:
- Whether the number field is set.
-
getNumber
int getNumber()
optional int32 number = 3;
- Returns:
- The number.
-
hasLabel
boolean hasLabel()
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
- Returns:
- Whether the label field is set.
-
getLabel
DescriptorProtos.FieldDescriptorProto.Label getLabel()
optional .google.protobuf.FieldDescriptorProto.Label label = 4;
- Returns:
- The label.
-
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;
- Returns:
- Whether the type field is set.
-
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;
- Returns:
- The type.
-
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;
- Returns:
- Whether the typeName field is set.
-
getTypeName
java.lang.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;
- Returns:
- The typeName.
-
getTypeNameBytes
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;
- Returns:
- The bytes for typeName.
-
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;
- Returns:
- Whether the extendee field is set.
-
getExtendee
java.lang.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;
- Returns:
- The extendee.
-
getExtendeeBytes
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;
- Returns:
- The bytes for extendee.
-
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;
- Returns:
- Whether the defaultValue field is set.
-
getDefaultValue
java.lang.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;
- Returns:
- The defaultValue.
-
getDefaultValueBytes
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;
- Returns:
- The bytes for defaultValue.
-
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;
- Returns:
- Whether the oneofIndex field is set.
-
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;
- Returns:
- The oneofIndex.
-
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;
- Returns:
- Whether the jsonName field is set.
-
getJsonName
java.lang.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;
- Returns:
- The jsonName.
-
getJsonNameBytes
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;
- Returns:
- The bytes for jsonName.
-
hasOptions
boolean hasOptions()
optional .google.protobuf.FieldOptions options = 8;
- Returns:
- Whether the options field is set.
-
getOptions
DescriptorProtos.FieldOptions getOptions()
optional .google.protobuf.FieldOptions options = 8;
- Returns:
- The options.
-
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;
- Returns:
- Whether the proto3Optional field is set.
-
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;
- Returns:
- The proto3Optional.
-
-