Interface DescriptorProtos.FieldDescriptorProtoOrBuilder

public static interface DescriptorProtos.FieldDescriptorProtoOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDefaultValue()

public abstract 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
TypeDescription
String

The defaultValue.

getDefaultValueBytes()

public abstract 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
TypeDescription
ByteString

The bytes for defaultValue.

getExtendee()

public abstract 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
TypeDescription
String

The extendee.

getExtendeeBytes()

public abstract 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
TypeDescription
ByteString

The bytes for extendee.

getJsonName()

public abstract 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
TypeDescription
String

The jsonName.

getJsonNameBytes()

public abstract 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
TypeDescription
ByteString

The bytes for jsonName.

getLabel()

public abstract DescriptorProtos.FieldDescriptorProto.Label getLabel()

optional .google.protobuf.FieldDescriptorProto.Label label = 4;

Returns
TypeDescription
DescriptorProtos.FieldDescriptorProto.Label

The label.

getName()

public abstract String getName()

optional string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

optional string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getNumber()

public abstract int getNumber()

optional int32 number = 3;

Returns
TypeDescription
int

The number.

getOneofIndex()

public abstract 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
TypeDescription
int

The oneofIndex.

getOptions()

public abstract DescriptorProtos.FieldOptions getOptions()

optional .google.protobuf.FieldOptions options = 8;

Returns
TypeDescription
DescriptorProtos.FieldOptions

The options.

getOptionsOrBuilder()

public abstract DescriptorProtos.FieldOptionsOrBuilder getOptionsOrBuilder()

optional .google.protobuf.FieldOptions options = 8;

Returns
TypeDescription
DescriptorProtos.FieldOptionsOrBuilder

getProto3Optional()

public abstract 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
TypeDescription
boolean

The proto3Optional.

getType()

public abstract 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
TypeDescription
DescriptorProtos.FieldDescriptorProto.Type

The type.

getTypeName()

public abstract 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
TypeDescription
String

The typeName.

getTypeNameBytes()

public abstract 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
TypeDescription
ByteString

The bytes for typeName.

hasDefaultValue()

public abstract 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
TypeDescription
boolean

Whether the defaultValue field is set.

hasExtendee()

public abstract 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
TypeDescription
boolean

Whether the extendee field is set.

hasJsonName()

public abstract 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
TypeDescription
boolean

Whether the jsonName field is set.

hasLabel()

public abstract boolean hasLabel()

optional .google.protobuf.FieldDescriptorProto.Label label = 4;

Returns
TypeDescription
boolean

Whether the label field is set.

hasName()

public abstract boolean hasName()

optional string name = 1;

Returns
TypeDescription
boolean

Whether the name field is set.

hasNumber()

public abstract boolean hasNumber()

optional int32 number = 3;

Returns
TypeDescription
boolean

Whether the number field is set.

hasOneofIndex()

public abstract 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
TypeDescription
boolean

Whether the oneofIndex field is set.

hasOptions()

public abstract boolean hasOptions()

optional .google.protobuf.FieldOptions options = 8;

Returns
TypeDescription
boolean

Whether the options field is set.

hasProto3Optional()

public abstract 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
TypeDescription
boolean

Whether the proto3Optional field is set.

hasType()

public abstract 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
TypeDescription
boolean

Whether the type field is set.

hasTypeName()

public abstract 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
TypeDescription
boolean

Whether the typeName field is set.