Package com.google.protobuf

Class DescriptorProtos.FieldDescriptorProto

java.lang.Object
com.google.protobuf.AbstractMessageLite<DescriptorProtos.FieldDescriptorProto,DescriptorProtos.FieldDescriptorProto.Builder>
com.google.protobuf.GeneratedMessageLite<DescriptorProtos.FieldDescriptorProto,DescriptorProtos.FieldDescriptorProto.Builder>
com.google.protobuf.DescriptorProtos.FieldDescriptorProto
All Implemented Interfaces:
DescriptorProtos.FieldDescriptorProtoOrBuilder, MessageLite, MessageLiteOrBuilder
Enclosing class:
DescriptorProtos
public static final class DescriptorProtos.FieldDescriptorProto extends GeneratedMessageLite<DescriptorProtos.FieldDescriptorProto,DescriptorProtos.FieldDescriptorProto.Builder> implements DescriptorProtos.FieldDescriptorProtoOrBuilder
 Describes a field within a message.
Protobuf type google.protobuf.FieldDescriptorProto

  • Field Details

  • Constructor Details

    • FieldDescriptorProto

      private FieldDescriptorProto()

  • Method Details

    • 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 ByteString getNameBytes()
      optional string name = 1;
      Specified by:
      getNameBytes in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The bytes for name.

    • setName

      private void setName(String value)
      optional string name = 1;
      Parameters:
      value - The name to set.

    • clearName

      private void clearName()
      optional string name = 1;

    • setNameBytes

      private void setNameBytes(ByteString value)
      optional string name = 1;
      Parameters:
      value - The bytes for name to set.

    • 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.

    • setNumber

      private void setNumber(int value)
      optional int32 number = 3;
      Parameters:
      value - The number to set.

    • clearNumber

      private void clearNumber()
      optional int32 number = 3;

    • 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.

    • setLabel

      private void setLabel(DescriptorProtos.FieldDescriptorProto.Label value)
      optional .google.protobuf.FieldDescriptorProto.Label label = 4;
      Parameters:
      value - The label to set.

    • clearLabel

      private void clearLabel()
      optional .google.protobuf.FieldDescriptorProto.Label label = 4;

    • 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.

    • setType

      private void 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 type to set.

    • clearType

      private void 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;

    • 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 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.

    • setTypeName

      private void setTypeName(String value)
       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.

    • clearTypeName

      private void 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;

    • setTypeNameBytes

      private void setTypeNameBytes(ByteString value)
       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.

    • 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 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.

    • setExtendee

      private void setExtendee(String value)
       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.

    • clearExtendee

      private void 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;

    • setExtendeeBytes

      private void setExtendeeBytes(ByteString value)
       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.

    • 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 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.
      optional string default_value = 7;
      Specified by:
      getDefaultValue in interface DescriptorProtos.FieldDescriptorProtoOrBuilder
      Returns:
      The defaultValue.

    • getDefaultValueBytes

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

    • setDefaultValue

      private void setDefaultValue(String value)
       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.

    • clearDefaultValue

      private void 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;

    • setDefaultValueBytes

      private void setDefaultValueBytes(ByteString value)
       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.

    • 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.

    • setOneofIndex

      private void setOneofIndex(int value)
       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.

    • clearOneofIndex

      private void 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;

    • 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 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.

    • setJsonName

      private void setJsonName(String value)
       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.

    • clearJsonName

      private void 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;

    • setJsonNameBytes

      private void setJsonNameBytes(ByteString value)
       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.

    • 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.

    • setOptions

      private void setOptions(DescriptorProtos.FieldOptions value)
      optional .google.protobuf.FieldOptions options = 8;

    • mergeOptions

      private void mergeOptions(DescriptorProtos.FieldOptions value)
      optional .google.protobuf.FieldOptions options = 8;

    • clearOptions

      private void 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 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 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.

    • setProto3Optional

      private void setProto3Optional(boolean value)
       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.

    • clearProto3Optional

      private void 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;

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static DescriptorProtos.FieldDescriptorProto parseFrom(InputStream input, 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, ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static DescriptorProtos.FieldDescriptorProto.Builder newBuilder()

    • newBuilder

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

    • dynamicMethod

      protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Description copied from class: GeneratedMessageLite
      A method that implements different types of operations described in GeneratedMessageLite.MethodToInvoke. These different kinds of operations are required to implement message-level operations for builders in the runtime. This method bundles those operations to reduce the generated methods count.
      • NEW_INSTANCE returns a new instance of the protocol buffer that has not yet been made immutable. See MAKE_IMMUTABLE.
      • IS_INITIALIZED returns null for false and the default instance for true. It doesn't use or modify any memoized value.
      • GET_MEMOIZED_IS_INITIALIZED returns the memoized isInitialized byte value.
      • SET_MEMOIZED_IS_INITIALIZED sets the memoized isInitialized byte value to 1 if the first parameter is not null, or to 0 if the first parameter is null.
      • NEW_BUILDER returns a BuilderType instance.
      This method, plus the implementation of the Builder, enables the Builder class to be proguarded away entirely on Android.

      For use by generated code only.

      Specified by:
      dynamicMethod in class GeneratedMessageLite<DescriptorProtos.FieldDescriptorProto,DescriptorProtos.FieldDescriptorProto.Builder>

    • getDefaultInstance

      public static DescriptorProtos.FieldDescriptorProto getDefaultInstance()

    • parser

      public static Parser<DescriptorProtos.FieldDescriptorProto> parser()