Descriptors.FieldDescriptor

java.lang.Object
- com.google.protobuf.Descriptors.GenericDescriptor
- - com.google.protobuf.Descriptors.FieldDescriptor

All Implemented Interfaces:: FieldSet.FieldDescriptorLite<Descriptors.FieldDescriptor>, java.lang.Comparable<Descriptors.FieldDescriptor>

Enclosing class:: Descriptors

public static final class Descriptors.FieldDescriptor
extends Descriptors.GenericDescriptor
implements java.lang.Comparable<Descriptors.FieldDescriptor>, FieldSet.FieldDescriptorLite<Descriptors.FieldDescriptor>

Describes a field of a message type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Descriptors.FieldDescriptor.JavaType

static class Descriptors.FieldDescriptor.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`Descriptors.FieldDescriptor.JavaType`
`static class`	`Descriptors.FieldDescriptor.Type`

Field Summary

Fields
Modifier and Type	Field and Description
`private Descriptors.OneofDescriptor`	`containingOneof`
`private Descriptors.Descriptor`	`containingType`
`private java.lang.Object`	`defaultValue`
`private Descriptors.EnumDescriptor`	`enumType`
`private Descriptors.Descriptor`	`extensionScope`
`private Descriptors.FileDescriptor`	`file`
`private java.lang.String`	`fullName`
`private int`	`index`
`private java.lang.String`	`jsonName`
`private Descriptors.Descriptor`	`messageType`
`private DescriptorProtos.FieldDescriptorProto`	`proto`
`private static WireFormat.FieldType[]`	`table`
`private Descriptors.FieldDescriptor.Type`	`type`

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`FieldDescriptor(DescriptorProtos.FieldDescriptorProto proto, Descriptors.FileDescriptor file, Descriptors.Descriptor parent, int index, boolean isExtension)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Descriptors.FieldDescriptor other)` Compare with another `FieldDescriptor`.
`private void`	`crossLink()` Look up and cross-link all field types, etc.
`private static java.lang.String`	`fieldNameToJsonName(java.lang.String name)`
`Descriptors.OneofDescriptor`	`getContainingOneof()` Get the field's containing oneof.
`Descriptors.Descriptor`	`getContainingType()` Get the field's containing type.
`java.lang.Object`	`getDefaultValue()` Returns the field's default value.
`Descriptors.EnumDescriptor`	`getEnumType()` For enum fields, gets the field's type.
`Descriptors.Descriptor`	`getExtensionScope()` For extensions defined nested within message types, gets the outer type.
`Descriptors.FileDescriptor`	`getFile()` Get the `FileDescriptor` containing this descriptor.
`java.lang.String`	`getFullName()` Get the field's fully-qualified name.
`int`	`getIndex()` Get the index of this descriptor within its parent.
`Descriptors.FieldDescriptor.JavaType`	`getJavaType()` Get the field's java type.
`java.lang.String`	`getJsonName()` Get the JSON name of this field.
`WireFormat.JavaType`	`getLiteJavaType()` For internal use only.
`WireFormat.FieldType`	`getLiteType()` For internal use only.
`Descriptors.Descriptor`	`getMessageType()` For embedded message and group fields, gets the field's type.
`java.lang.String`	`getName()` Get the field's unqualified name.
`int`	`getNumber()` Get the field's number.
`DescriptorProtos.FieldOptions`	`getOptions()` Get the `FieldOptions`, defined in `descriptor.proto`.
`Descriptors.FieldDescriptor.Type`	`getType()` Get the field's declared type.
`boolean`	`hasDefaultValue()` Returns true if the field had an explicitly-defined default value.
`MessageLite.Builder`	`internalMergeFrom(MessageLite.Builder to, MessageLite from)` For internal use only.
`boolean`	`isExtension()` Is this field an extension?
`boolean`	`isMapField()`
`boolean`	`isOptional()` Is this field declared optional?
`boolean`	`isPackable()` Can this field be packed? i.e.
`boolean`	`isPacked()` Does this field have the `[packed = true]` option or is this field packable in proto3 and not explicitly setted to unpacked?
`boolean`	`isRepeated()` Is this field declared repeated?
`boolean`	`isRequired()` Is this field declared required?
`boolean`	`needsUtf8Check()` For internal use only.
`private void`	`setProto(DescriptorProtos.FieldDescriptorProto proto)` See `Descriptors.FileDescriptor.setProto(com.google.protobuf.DescriptorProtos.FileDescriptorProto)`.
`DescriptorProtos.FieldDescriptorProto`	`toProto()` Convert the descriptor to its protocol message representation.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - table
```
private static final WireFormat.FieldType[] table
```
  - index
```
private final int index
```
  - proto
```
private DescriptorProtos.FieldDescriptorProto proto
```
  - fullName
```
private final java.lang.String fullName
```
  - jsonName
```
private final java.lang.String jsonName
```
  - file
```
private final Descriptors.FileDescriptor file
```
  - extensionScope
```
private final Descriptors.Descriptor extensionScope
```
  - type
```
private Descriptors.FieldDescriptor.Type type
```
  - containingType
```
private Descriptors.Descriptor containingType
```
  - messageType
```
private Descriptors.Descriptor messageType
```
  - containingOneof
```
private Descriptors.OneofDescriptor containingOneof
```
  - enumType
```
private Descriptors.EnumDescriptor enumType
```
  - defaultValue
```
private java.lang.Object defaultValue
```
- Constructor Detail
  - FieldDescriptor
```
private FieldDescriptor(DescriptorProtos.FieldDescriptorProto proto,
                        Descriptors.FileDescriptor file,
                        Descriptors.Descriptor parent,
                        int index,
                        boolean isExtension)
                 throws Descriptors.DescriptorValidationException
```
    Throws:
    
    Descriptors.DescriptorValidationException
- Method Detail
  - getIndex
```
public int getIndex()
```
    Get the index of this descriptor within its parent.
    
    See Also:
    
    Descriptors.Descriptor.getIndex()
  - toProto
```
public DescriptorProtos.FieldDescriptorProto toProto()
```
    Convert the descriptor to its protocol message representation.
    
    Specified by:
    
    toProto in class Descriptors.GenericDescriptor
  - getName
```
public java.lang.String getName()
```
    Get the field's unqualified name.
    
    Specified by:
    
    getName in class Descriptors.GenericDescriptor
  - getNumber
```
public int getNumber()
```
    Get the field's number.
    
    Specified by:
    
    getNumber in interface FieldSet.FieldDescriptorLite<Descriptors.FieldDescriptor>
  - getFullName
```
public java.lang.String getFullName()
```
    Get the field's fully-qualified name.
    
    Specified by:
    
    getFullName in class Descriptors.GenericDescriptor
    
    See Also:
    
    Descriptors.Descriptor.getFullName()
  - 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.
  - getLiteJavaType
```
public WireFormat.JavaType getLiteJavaType()
```
    For internal use only.
    
    Specified by:
    
    getLiteJavaType in interface FieldSet.FieldDescriptorLite<Descriptors.FieldDescriptor>
  - getFile
```
public Descriptors.FileDescriptor getFile()
```
    Get the FileDescriptor containing this descriptor.
    
    Specified by:
    
    getFile in class Descriptors.GenericDescriptor
  - getType
```
public Descriptors.FieldDescriptor.Type getType()
```
    Get the field's declared type.
  - getLiteType
```
public WireFormat.FieldType getLiteType()
```
    For internal use only.
    
    Specified by:
    
    getLiteType in interface FieldSet.FieldDescriptorLite<Descriptors.FieldDescriptor>
  - 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 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 setted to unpacked?
    
    Specified by:
    
    isPacked in interface FieldSet.FieldDescriptorLite<Descriptors.FieldDescriptor>
  - isPackable
```
public boolean isPackable()
```
    Can this field be packed? i.e. 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).
  - getOptions
```
public DescriptorProtos.FieldOptions getOptions()
```
    Get the FieldOptions, defined in descriptor.proto.
  - 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().
  - getContainingOneof
```
public Descriptors.OneofDescriptor getContainingOneof()
```
    Get the field's containing oneof.
  - 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 qux = 4321;
     }
   }
 
```
    Both baz's and qux's containing type is Foo. However, baz's extension scope is null while qux's extension scope is Bar.
  - getMessageType
```
public Descriptors.Descriptor getMessageType()
```
    For embedded message and group fields, gets the field's type.
  - getEnumType
```
public Descriptors.EnumDescriptor getEnumType()
```
    For enum fields, gets the field's type.
    
    Specified by:
    
    getEnumType in interface FieldSet.FieldDescriptorLite<Descriptors.FieldDescriptor>
  - 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 -- i.e. 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
  - fieldNameToJsonName
```
private static java.lang.String fieldNameToJsonName(java.lang.String name)
```
  - crossLink
```
private void crossLink()
                throws Descriptors.DescriptorValidationException
```
    Look up and cross-link all field types, etc.
    
    Throws:
    
    Descriptors.DescriptorValidationException
  - setProto
```
private void setProto(DescriptorProtos.FieldDescriptorProto proto)
```
    See Descriptors.FileDescriptor.setProto(com.google.protobuf.DescriptorProtos.FileDescriptorProto).
  - internalMergeFrom
```
public MessageLite.Builder internalMergeFrom(MessageLite.Builder to,
                                             MessageLite from)
```
    For internal use only. This is to satisfy the FieldDescriptorLite interface.
    
    Specified by:
    
    internalMergeFrom in interface FieldSet.FieldDescriptorLite<Descriptors.FieldDescriptor>

Class Descriptors.FieldDescriptor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

table

index

proto

fullName

jsonName

file

extensionScope

type

containingType

messageType

containingOneof

enumType

defaultValue

Constructor Detail

FieldDescriptor

Method Detail

getIndex

toProto

getName

getNumber

getFullName

getJsonName

getJavaType

getLiteJavaType

getFile

getType

getLiteType

needsUtf8Check

isMapField

isRequired

isOptional

isRepeated

isPacked

isPackable

hasDefaultValue

getDefaultValue

getOptions

isExtension

getContainingType

getContainingOneof

getExtensionScope

getMessageType

getEnumType

compareTo

toString

fieldNameToJsonName

crossLink

setProto

internalMergeFrom