Package com.google.protobuf

Class Descriptors.FieldDescriptor

    • Method Detail

      • getNumber

        public int getNumber()
        Get the field's number.
        Specified by:
        getNumber in interface com.google.protobuf.FieldSet.FieldDescriptorLite<Descriptors.FieldDescriptor>

      • getJsonName

        public java.lang.String getJsonName()
        Get the JSON name of this field.

      • getJavaType

        public Descriptors.FieldDescriptor.JavaType getJavaType()
        Get the field's java type. This is just for convenience. Every FieldDescriptorProto.Type maps to exactly one Java type.

      • needsUtf8Check

        public boolean needsUtf8Check()
        For internal use only.

      • isMapField

        public boolean isMapField()

      • isRequired

        public boolean isRequired()
        Is this field declared required?

      • isOptional

        public boolean isOptional()
        Is this field declared optional?

      • isRepeated

        public boolean isRepeated()
        Is this field declared repeated?
        Specified by:
        isRepeated in interface com.google.protobuf.FieldSet.FieldDescriptorLite<Descriptors.FieldDescriptor>

      • isPacked

        public boolean isPacked()
        Does this field have the [packed = true] option or is this field packable in proto3 and not explicitly set to unpacked?
        Specified by:
        isPacked in interface com.google.protobuf.FieldSet.FieldDescriptorLite<Descriptors.FieldDescriptor>

      • isPackable

        public boolean isPackable()
        Can this field be packed? That is, is it a repeated primitive field?

      • hasDefaultValue

        public boolean hasDefaultValue()
        Returns true if the field had an explicitly-defined default value.

      • getDefaultValue

        public java.lang.Object getDefaultValue()
        Returns the field's default value. Valid for all types except for messages and groups. For all other types, the object returned is of the same class that would returned by Message.getField(this).

      • isExtension

        public boolean isExtension()
        Is this field an extension?

      • getContainingType

        public Descriptors.Descriptor getContainingType()
        Get the field's containing type. For extensions, this is the type being extended, not the location where the extension was defined. See getExtensionScope().

      • getRealContainingOneof

        public Descriptors.OneofDescriptor getRealContainingOneof()
        Get the field's containing oneof, only if non-synthetic.

      • hasPresence

        public boolean hasPresence()
        Returns true if this field tracks presence, ie. does the field distinguish between "unset" and "present with default value."

        This includes required, optional, and oneof fields. It excludes maps, repeated fields, and singular proto3 fields without "optional".

        For fields where hasPresence() == true, the return value of msg.hasField() is semantically meaningful.

      • getExtensionScope

        public Descriptors.Descriptor getExtensionScope()
        For extensions defined nested within message types, gets the outer type. Not valid for non-extension fields. For example, consider this .proto file: 
           message Foo {
     extensions 1000 to max;
   }
   extend Foo {
     optional int32 baz = 1234;
   }
   message Bar {
     extend Foo {
       optional int32 moo = 4321;
     }
   }
        Both baz's and moo's containing type is Foo. However, baz's extension scope is null while moo's extension scope is Bar.

      • getMessageType

        public Descriptors.Descriptor getMessageType()
        For embedded message and group fields, gets the field's type.

      • legacyEnumFieldTreatedAsClosed

        public boolean legacyEnumFieldTreatedAsClosed()
        Determines if the given enum field is treated as closed based on legacy non-conformant behavior.

        Conformant behavior determines closedness based on the enum and can be queried using EnumDescriptor.isClosed().

        Some runtimes currently have a quirk where non-closed enums are treated as closed when used as the type of fields defined in a `syntax = proto2;` file. This quirk is not present in all runtimes; as of writing, we know that:

        • C++, Java, and C++-based Python share this quirk.
        • UPB and UPB-based Python do not.
        • PHP and Ruby treat all enums as open regardless of declaration.

        Care should be taken when using this function to respect the target runtime's enum handling quirks.

      • compareTo

        public int compareTo​(Descriptors.FieldDescriptor other)
        Compare with another FieldDescriptor. This orders fields in "canonical" order, which simply means ascending order by field number. other must be a field of the same type. That is, getContainingType() must return the same Descriptor for both fields.
        Specified by:
        compareTo in interface java.lang.Comparable<Descriptors.FieldDescriptor>
        Returns:
        negative, zero, or positive if this is less than, equal to, or greater than other, respectively

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object