Class Descriptors.Descriptor

java.lang.Object

com.google.protobuf.Descriptors.GenericDescriptor

com.google.protobuf.Descriptors.Descriptor

Enclosing class:

Descriptors

public static final class Descriptors.Descriptor
extends Descriptors.GenericDescriptor

Describes a message type.

Field Summary

Fields

Modifier and Type	Field	Description
private final Descriptors.EnumDescriptor[]	enumTypes
private final int[]	extensionRangeLowerBounds
private final int[]	extensionRangeUpperBounds
private final Descriptors.FieldDescriptor[]	extensions
private final Descriptors.FieldDescriptor[]	fields
private final Descriptors.FieldDescriptor[]	fieldsSortedByNumber
private final String	fullName
private final int	index
private final Descriptors.Descriptor[]	nestedTypes
private final Descriptors.OneofDescriptor[]	oneofs
private DescriptorProtos.MessageOptions	options
private final Descriptors.GenericDescriptor	parent
private final boolean	placeholder
private DescriptorProtos.DescriptorProto	proto
private final int	realOneofCount

Fields inherited from class Descriptors.GenericDescriptor

features

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Descriptor(DescriptorProtos.DescriptorProto proto, Descriptors.FileDescriptor file, Descriptors.Descriptor parent, int index)
(package private)	Descriptor(String fullname)

Method Summary

Modifier and Type	Method	Description
private void	crossLink()	Look up and cross-link all field types, etc.
Descriptors.EnumDescriptor	findEnumTypeByName(String name)	Finds a nested enum type by name.
Descriptors.FieldDescriptor	findFieldByName(String name)	Finds a field by name.
Descriptors.FieldDescriptor	findFieldByNumber(int number)	Finds a field by field number.
Descriptors.Descriptor	findNestedTypeByName(String name)	Finds a nested message type by name.
Descriptors.Descriptor	getContainingType()	If this is a nested type, get the outer descriptor, otherwise null.
Descriptors.EnumDescriptor	getEnumType(int index)	Get the message type's nested enum type at the specified index.
int	getEnumTypeCount()	Get a count of enum types nested within this one.
List<Descriptors.EnumDescriptor>	getEnumTypes()	Get a list of enum types nested within this one.
Descriptors.FieldDescriptor	getExtension(int index)	Get the extension defined nested within this message type's scope at the specified index.
int	getExtensionCount()	Get a count of the extensions defined nested within this message type's scope.
List<Descriptors.FieldDescriptor>	getExtensions()	Get a list of the extensions defined nested within this message type's scope.
Descriptors.FieldDescriptor	getField(int index)	Get the message type's field at the specified index.
int	getFieldCount()	Get a count of this message type's fields.
List<Descriptors.FieldDescriptor>	getFields()	Get a list of this message type's fields.
Descriptors.FileDescriptor	getFile()	Get the Descriptors.FileDescriptor containing this descriptor.
String	getFullName()	Get the type's fully-qualified name, within the proto language's namespace.
int	getIndex()	Get the index of this descriptor within its parent.
String	getName()	Get the type's unqualified name.
Descriptors.Descriptor	getNestedType(int index)	Get the message type's nested message type at the specified index.
int	getNestedTypeCount()	Get a count of message types nested within this one.
List<Descriptors.Descriptor>	getNestedTypes()	Get a list of message types nested within this one.
Descriptors.OneofDescriptor	getOneof(int index)	Get the message type's oneof at the specified index.
int	getOneofCount()	Get a count of this message type's oneofs.
List<Descriptors.OneofDescriptor>	getOneofs()	Get a list of this message type's oneofs.
DescriptorProtos.MessageOptions	getOptions()	Get the MessageOptions, defined in descriptor.proto.
(package private) Descriptors.GenericDescriptor	getParent()
Descriptors.OneofDescriptor	getRealOneof(int index)	Get the message type's real oneof at the specified index.
int	getRealOneofCount()	Get a count of this message type's real oneofs.
List<Descriptors.OneofDescriptor>	getRealOneofs()	Get a list of this message type's real oneofs.
boolean	isExtendable()	Indicates whether the message can be extended.
boolean	isExtensionNumber(int number)	Determines if the given field number is an extension.
boolean	isPlaceholder()
boolean	isReservedName(String name)	Determines if the given field name is reserved.
boolean	isReservedNumber(int number)	Determines if the given field number is reserved.
private void	resolveAllFeatures()	See invalid reference FileDescriptor#resolveAllFeatures .
private void	setProto(DescriptorProtos.DescriptorProto proto)	See Descriptors.FileDescriptor.setProto(DescriptorProtos.FileDescriptorProto).
DescriptorProtos.DescriptorProto	toProto()	Convert the descriptor to its protocol message representation.
private void	validateNoDuplicateFieldNumbers()

Methods inherited from class Descriptors.GenericDescriptor

getFeatures, inferLegacyProtoFeatures, resolveFeatures, validateFeatures

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

index

private final int index

proto

private DescriptorProtos.DescriptorProto proto

options

private volatile DescriptorProtos.MessageOptions options

fullName

private final String fullName

parent

private final Descriptors.GenericDescriptor parent

nestedTypes

private final Descriptors.Descriptor[] nestedTypes

enumTypes

private final Descriptors.EnumDescriptor[] enumTypes

fields

private final Descriptors.FieldDescriptor[] fields

fieldsSortedByNumber

private final Descriptors.FieldDescriptor[] fieldsSortedByNumber

extensions

private final Descriptors.FieldDescriptor[] extensions

oneofs

private final Descriptors.OneofDescriptor[] oneofs

realOneofCount

private final int realOneofCount

extensionRangeLowerBounds

private final int[] extensionRangeLowerBounds

extensionRangeUpperBounds

private final int[] extensionRangeUpperBounds

placeholder

private final boolean placeholder

Constructor Details

Descriptor

Descriptor(String fullname)
    throws Descriptors.DescriptorValidationException

Throws:

Descriptors.DescriptorValidationException

Descriptor

private Descriptor(DescriptorProtos.DescriptorProto proto,
 Descriptors.FileDescriptor file,
 Descriptors.Descriptor parent,
 int index)
            throws Descriptors.DescriptorValidationException

Throws:

Descriptors.DescriptorValidationException

Method Details

getIndex

public int getIndex()

Get the index of this descriptor within its parent. In other words, given a Descriptors.FileDescriptor file, the following is true:

  for all i in [0, file.getMessageTypeCount()):
    file.getMessageType(i).getIndex() == i

Similarly, for a Descriptors.Descriptor messageType:

  for all i in [0, messageType.getNestedTypeCount()):
    messageType.getNestedType(i).getIndex() == i

toProto

public DescriptorProtos.DescriptorProto toProto()

Convert the descriptor to its protocol message representation.

Specified by:

toProto in class Descriptors.GenericDescriptor

getName

public String getName()

Get the type's unqualified name.

Specified by:

getName in class Descriptors.GenericDescriptor

getFullName

public String getFullName()

Get the type's fully-qualified name, within the proto language's namespace. This differs from the Java name. For example, given this .proto:

  package foo.bar;
  option java_package = "com.example.protos"
  message Baz {}

Baz's full name is "foo.bar.Baz".

Specified by:

getFullName in class Descriptors.GenericDescriptor

getFile

public Descriptors.FileDescriptor getFile()

Get the Descriptors.FileDescriptor containing this descriptor.

Specified by:

getFile in class Descriptors.GenericDescriptor

getParent

Descriptors.GenericDescriptor getParent()

Specified by:

getParent in class Descriptors.GenericDescriptor

isPlaceholder

public boolean isPlaceholder()

getContainingType

public Descriptors.Descriptor getContainingType()

If this is a nested type, get the outer descriptor, otherwise null.

getOptions

public DescriptorProtos.MessageOptions getOptions()

Get the MessageOptions, defined in descriptor.proto.

getFields

public List<Descriptors.FieldDescriptor> getFields()

Get a list of this message type's fields.

getFieldCount

public int getFieldCount()

Get a count of this message type's fields.

getField

public Descriptors.FieldDescriptor getField(int index)

Get the message type's field at the specified index.

getOneofs

public List<Descriptors.OneofDescriptor> getOneofs()

Get a list of this message type's oneofs.

getOneofCount

public int getOneofCount()

Get a count of this message type's oneofs.

getOneof

public Descriptors.OneofDescriptor getOneof(int index)

Get the message type's oneof at the specified index.

getRealOneofs

public List<Descriptors.OneofDescriptor> getRealOneofs()

Get a list of this message type's real oneofs.

getRealOneofCount

public int getRealOneofCount()

Get a count of this message type's real oneofs.

getRealOneof

public Descriptors.OneofDescriptor getRealOneof(int index)

Get the message type's real oneof at the specified index.

getExtensions

public List<Descriptors.FieldDescriptor> getExtensions()

Get a list of the extensions defined nested within this message type's scope.

getExtensionCount

public int getExtensionCount()

Get a count of the extensions defined nested within this message type's scope.

getExtension

public Descriptors.FieldDescriptor getExtension(int index)

Get the extension defined nested within this message type's scope at the specified index.

getNestedTypes

public List<Descriptors.Descriptor> getNestedTypes()

Get a list of message types nested within this one.

getNestedTypeCount

public int getNestedTypeCount()

Get a count of message types nested within this one.

getNestedType

public Descriptors.Descriptor getNestedType(int index)

Get the message type's nested message type at the specified index.

getEnumTypes

public List<Descriptors.EnumDescriptor> getEnumTypes()

Get a list of enum types nested within this one.

getEnumTypeCount

public int getEnumTypeCount()

Get a count of enum types nested within this one.

getEnumType

public Descriptors.EnumDescriptor getEnumType(int index)

Get the message type's nested enum type at the specified index.

isExtensionNumber

public boolean isExtensionNumber(int number)

Determines if the given field number is an extension.

isReservedNumber

public boolean isReservedNumber(int number)

Determines if the given field number is reserved.

isReservedName

public boolean isReservedName(String name)

Determines if the given field name is reserved.

isExtendable

public boolean isExtendable()

Indicates whether the message can be extended. That is, whether it has any "extensions x to y" ranges declared on it.

findFieldByName

public Descriptors.FieldDescriptor findFieldByName(String name)

Finds a field by name.

Parameters:

name - The unqualified name of the field (e.g. "foo"). For protocol buffer messages that follow Google's guidance on naming this will be a snake case string, such as

song_name

.

Returns:

The field's descriptor, or null if not found.

findFieldByNumber

public Descriptors.FieldDescriptor findFieldByNumber(int number)

Finds a field by field number.

Parameters:

number - The field number within this message type.

Returns:

The field's descriptor, or null if not found.

findNestedTypeByName

public Descriptors.Descriptor findNestedTypeByName(String name)

Finds a nested message type by name.

Parameters:

name - The unqualified name of the nested type such as "Foo"

Returns:

The types's descriptor, or null if not found.

findEnumTypeByName

public Descriptors.EnumDescriptor findEnumTypeByName(String name)

Finds a nested enum type by name.

Parameters:

name - The unqualified name of the nested type such as "Foo"

Returns:

The types's descriptor, or null if not found.

resolveAllFeatures

private void resolveAllFeatures()
                         throws Descriptors.DescriptorValidationException

See

invalid reference

FileDescriptor#resolveAllFeatures

.

Throws:

Descriptors.DescriptorValidationException

crossLink

private void crossLink()
                throws Descriptors.DescriptorValidationException

Look up and cross-link all field types, etc.

Throws:

Descriptors.DescriptorValidationException

validateNoDuplicateFieldNumbers

private void validateNoDuplicateFieldNumbers()
                                      throws Descriptors.DescriptorValidationException

Throws:

Descriptors.DescriptorValidationException

setProto

private void setProto(DescriptorProtos.DescriptorProto proto)
               throws Descriptors.DescriptorValidationException

See Descriptors.FileDescriptor.setProto(DescriptorProtos.FileDescriptorProto).

Throws:

Descriptors.DescriptorValidationException