Package com.google.protobuf

Class DescriptorProtos.FieldDescriptorProto

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.protobuf.DescriptorProtos.FieldDescriptorProto
All Implemented Interfaces:
DescriptorProtos.FieldDescriptorProtoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
DescriptorProtos
public static final class DescriptorProtos.FieldDescriptorProto extends com.google.protobuf.GeneratedMessageV3 implements DescriptorProtos.FieldDescriptorProtoOrBuilder
 Describes a field within a message.
Protobuf type google.protobuf.FieldDescriptorProto
See Also:

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasName

      public boolean hasName()
      optional string name = 1;
      Specified by:
      hasName in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
      optional string name = 1;
      Specified by:
      getName in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
      optional string name = 1;
      Specified by:
      getNameBytes in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The bytes for name.

    • hasNumber

      public boolean hasNumber()
      optional int32 number = 3;
      Specified by:
      hasNumber in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      Whether the number field is set.

    • getNumber

      public int getNumber()
      optional int32 number = 3;
      Specified by:
      getNumber in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The number.

    • hasLabel

      public boolean hasLabel()
      optional .google.protobuf.FieldDescriptorProto.Label label = 4;
      Specified by:
      hasLabel in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      Whether the label field is set.

    • getLabel

      public DescriptorProtos.FieldDescriptorProto.Label getLabel()
      optional .google.protobuf.FieldDescriptorProto.Label label = 4;
      Specified by:
      getLabel in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The label.

    • 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 interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      Whether the type field is set.

    • getType

      public 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;
      Specified by:
      getType in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The type.

    • 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 interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      Whether the typeName field is set.

    • getTypeName

      public 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;
      Specified by:
      getTypeName in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The typeName.

    • getTypeNameBytes

      public 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;
      Specified by:
      getTypeNameBytes in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The bytes for typeName.

    • 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 interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      Whether the extendee field is set.

    • getExtendee

      public 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;
      Specified by:
      getExtendee in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The extendee.

    • getExtendeeBytes

      public 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;
      Specified by:
      getExtendeeBytes in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The bytes for extendee.

    • 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.
 TODO(kenton):  Base-64 encode?
      optional string default_value = 7;
      Specified by:
      hasDefaultValue in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      Whether the defaultValue field is set.

    • getDefaultValue

      public 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;
      Specified by:
      getDefaultValue in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The defaultValue.

    • getDefaultValueBytes

      public 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;
      Specified by:
      getDefaultValueBytes in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The bytes for defaultValue.

    • 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 interface DescriptorProtos.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 interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The oneofIndex.

    • 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 interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      Whether the jsonName field is set.

    • getJsonName

      public 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;
      Specified by:
      getJsonName in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The jsonName.

    • getJsonNameBytes

      public 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;
      Specified by:
      getJsonNameBytes in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The bytes for jsonName.

    • hasOptions

      public boolean hasOptions()
      optional .google.protobuf.FieldOptions options = 8;
      Specified by:
      hasOptions in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      Whether the options field is set.

    • getOptions

      public DescriptorProtos.FieldOptions getOptions()
      optional .google.protobuf.FieldOptions options = 8;
      Specified by:
      getOptions in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The options.

    • getOptionsOrBuilder

      public DescriptorProtos.FieldOptionsOrBuilder getOptionsOrBuilder()
      optional .google.protobuf.FieldOptions options = 8;
      Specified by:
      getOptionsOrBuilder in interface DescriptorProtos.FieldDescriptorProtoOrBuilder

    • 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 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;
      Specified by:
      hasProto3Optional in interface DescriptorProtos.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 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;
      Specified by:
      getProto3Optional in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The proto3Optional.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DescriptorProtos.FieldDescriptorProto parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.FieldDescriptorProto parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.FieldDescriptorProto parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.FieldDescriptorProto parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.FieldDescriptorProto parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.FieldDescriptorProto parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DescriptorProtos.FieldDescriptorProto parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DescriptorProtos.FieldDescriptorProto parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DescriptorProtos.FieldDescriptorProto parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DescriptorProtos.FieldDescriptorProto parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DescriptorProtos.FieldDescriptorProto parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DescriptorProtos.FieldDescriptorProto parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DescriptorProtos.FieldDescriptorProto.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DescriptorProtos.FieldDescriptorProto.Builder newBuilder()

    • newBuilder

      public static DescriptorProtos.FieldDescriptorProto.Builder newBuilder(DescriptorProtos.FieldDescriptorProto prototype)

    • toBuilder

      public DescriptorProtos.FieldDescriptorProto.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DescriptorProtos.FieldDescriptorProto.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static DescriptorProtos.FieldDescriptorProto getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DescriptorProtos.FieldDescriptorProto> parser()

    • getParserForType

      public com.google.protobuf.Parser<DescriptorProtos.FieldDescriptorProto> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public DescriptorProtos.FieldDescriptorProto getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder