Class Descriptors.FileDescriptor

java.lang.Object

com.google.protobuf.Descriptors.GenericDescriptor

com.google.protobuf.Descriptors.FileDescriptor

Enclosing class:

Descriptors

public static final class Descriptors.FileDescriptor
extends Descriptors.GenericDescriptor

Describes a .proto file, including everything defined within. That includes, in particular, descriptors for all the messages and file descriptors for all other imported .proto files (dependencies).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Descriptors.FileDescriptor.InternalDescriptorAssigner	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
private final Descriptors.FileDescriptor[]	dependencies
private final Descriptors.EnumDescriptor[]	enumTypes
private final Descriptors.FieldDescriptor[]	extensions
private boolean	featuresResolved
private final Descriptors.Descriptor[]	messageTypes
private DescriptorProtos.FileOptions	options
private final boolean	placeholder
private DescriptorProtos.FileDescriptorProto	proto
private final Descriptors.FileDescriptor[]	publicDependencies
private final Descriptors.ServiceDescriptor[]	services
private final Descriptors.FileDescriptorTables	tables

Fields inherited from class Descriptors.GenericDescriptor

features

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FileDescriptor(DescriptorProtos.FileDescriptorProto proto, Descriptors.FileDescriptor[] dependencies, Descriptors.FileDescriptorTables tables, boolean allowUnknownDependencies)
(package private)	FileDescriptor(String packageName, Descriptors.Descriptor message)	Create a placeholder FileDescriptor for a message Descriptor.
private	FileDescriptor(String packageName, Descriptors.Descriptor[] messages, Descriptors.EnumDescriptor[] enums, DescriptorProtos.FileDescriptorProto proto)	Create a placeholder FileDescriptor
private	FileDescriptor(String packageName, Descriptors.EnumDescriptor enm)	Create a placeholder FileDescriptor for an EnumDescriptor.

Method Summary

Modifier and Type	Method	Description
static Descriptors.FileDescriptor	buildFrom(DescriptorProtos.FileDescriptorProto proto, Descriptors.FileDescriptor[] dependencies)	Construct a FileDescriptor.
static Descriptors.FileDescriptor	buildFrom(DescriptorProtos.FileDescriptorProto proto, Descriptors.FileDescriptor[] dependencies, boolean allowUnknownDependencies)	Construct a FileDescriptor.
private static Descriptors.FileDescriptor	buildFrom(DescriptorProtos.FileDescriptorProto proto, Descriptors.FileDescriptor[] dependencies, boolean allowUnknownDependencies, boolean allowUnresolvedFeatures)
void	copyHeadingTo(DescriptorProtos.FileDescriptorProto.Builder protoBuilder)
private void	crossLink()	Look up and cross-link all field types, etc.
private static Descriptors.FileDescriptor[]	findDescriptors(Class<?> descriptorOuterClass, String[] dependencyClassNames, String[] dependencyFileNames)
Descriptors.EnumDescriptor	findEnumTypeByName(String name)	Find an enum type in the file by name.
Descriptors.FieldDescriptor	findExtensionByName(String name)	Find an extension in the file by name.
Descriptors.Descriptor	findMessageTypeByName(String name)	Find a message type in the file by name.
Descriptors.ServiceDescriptor	findServiceByName(String name)	Find a service type in the file by name.
List<Descriptors.FileDescriptor>	getDependencies()	Get a list of this file's dependencies (imports).
(package private) DescriptorProtos.Edition	getEdition()	Get the edition of the .proto file.
Descriptors.EnumDescriptor	getEnumType(int index)
int	getEnumTypeCount()
List<Descriptors.EnumDescriptor>	getEnumTypes()	Get a list of top-level enum types declared in this file.
Descriptors.FieldDescriptor	getExtension(int index)
int	getExtensionCount()
List<Descriptors.FieldDescriptor>	getExtensions()	Get a list of top-level extensions declared in this file.
Descriptors.FileDescriptor	getFile()	Returns this object.
String	getFullName()	Returns the same as getName().
Descriptors.Descriptor	getMessageType(int index)
int	getMessageTypeCount()
List<Descriptors.Descriptor>	getMessageTypes()	Get a list of top-level message types declared in this file.
String	getName()	Get the file name.
DescriptorProtos.FileOptions	getOptions()	Get the FileOptions, defined in descriptor.proto.
String	getPackage()	Get the proto package name.
(package private) Descriptors.GenericDescriptor	getParent()
List<Descriptors.FileDescriptor>	getPublicDependencies()	Get a list of this file's public dependencies (public imports).
Descriptors.ServiceDescriptor	getService(int index)
int	getServiceCount()
List<Descriptors.ServiceDescriptor>	getServices()	Get a list of top-level services declared in this file.
(package private) DescriptorProtos.FeatureSet	inferLegacyProtoFeatures()
static Descriptors.FileDescriptor	internalBuildGeneratedFileFrom(String[] descriptorDataParts, Descriptors.FileDescriptor[] dependencies)	This method is to be called by generated code only.
static void	internalBuildGeneratedFileFrom(String[] descriptorDataParts, Descriptors.FileDescriptor[] dependencies, Descriptors.FileDescriptor.InternalDescriptorAssigner descriptorAssigner)	Deprecated. Any gencode which is using this method is far out of support and should be regenerated with a newer version of the protobuf compiler.
static Descriptors.FileDescriptor	internalBuildGeneratedFileFrom(String[] descriptorDataParts, Class<?> descriptorOuterClass, String[] dependencyClassNames, String[] dependencyFileNames)	This method is to be called by generated code only.
static void	internalUpdateFileDescriptor(Descriptors.FileDescriptor descriptor, ExtensionRegistry registry)	This method is to be called by generated code only.
boolean	isPlaceholder()
private static byte[]	latin1Cat(String[] strings)
void	resolveAllFeaturesImmutable()
private void	resolveAllFeaturesInternal()	This method is to be called by generated code only.
private void	setProto(DescriptorProtos.FileDescriptorProto proto)	Replace our DescriptorProtos.FileDescriptorProto with the given one, which is identical except that it might contain extensions that weren't present in the original.
DescriptorProtos.FileDescriptorProto	toProto()	Convert the descriptor to its protocol message representation.

Methods inherited from class Descriptors.GenericDescriptor

getFeatures, resolveFeatures, validateFeatures

Methods inherited from class Object

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

Field Details

proto

private DescriptorProtos.FileDescriptorProto proto

options

private volatile DescriptorProtos.FileOptions options

messageTypes

private final Descriptors.Descriptor[] messageTypes

enumTypes

private final Descriptors.EnumDescriptor[] enumTypes

services

private final Descriptors.ServiceDescriptor[] services

extensions

private final Descriptors.FieldDescriptor[] extensions

dependencies

private final Descriptors.FileDescriptor[] dependencies

publicDependencies

private final Descriptors.FileDescriptor[] publicDependencies

tables

private final Descriptors.FileDescriptorTables tables

placeholder

private final boolean placeholder

featuresResolved

private volatile boolean featuresResolved

Constructor Details

FileDescriptor

private FileDescriptor(DescriptorProtos.FileDescriptorProto proto,
 Descriptors.FileDescriptor[] dependencies,
 Descriptors.FileDescriptorTables tables,
 boolean allowUnknownDependencies)
                throws Descriptors.DescriptorValidationException

Throws:

Descriptors.DescriptorValidationException

FileDescriptor

private FileDescriptor(String packageName,
 Descriptors.Descriptor[] messages,
 Descriptors.EnumDescriptor[] enums,
 DescriptorProtos.FileDescriptorProto proto)
                throws Descriptors.DescriptorValidationException

Create a placeholder FileDescriptor

Throws:

Descriptors.DescriptorValidationException

FileDescriptor

FileDescriptor(String packageName,
 Descriptors.Descriptor message)
        throws Descriptors.DescriptorValidationException

Create a placeholder FileDescriptor for a message Descriptor.

Throws:

Descriptors.DescriptorValidationException

FileDescriptor

private FileDescriptor(String packageName,
 Descriptors.EnumDescriptor enm)
                throws Descriptors.DescriptorValidationException

Create a placeholder FileDescriptor for an EnumDescriptor.

Throws:

Descriptors.DescriptorValidationException

Method Details

toProto

public DescriptorProtos.FileDescriptorProto toProto()

Convert the descriptor to its protocol message representation.

Specified by:

toProto in class Descriptors.GenericDescriptor

getName

public String getName()

Get the file name.

Specified by:

getName in class Descriptors.GenericDescriptor

getFile

public Descriptors.FileDescriptor getFile()

Returns this object.

Specified by:

getFile in class Descriptors.GenericDescriptor

getParent

Descriptors.GenericDescriptor getParent()

Specified by:

getParent in class Descriptors.GenericDescriptor

isPlaceholder

public boolean isPlaceholder()

getFullName

public String getFullName()

Returns the same as getName().

Specified by:

getFullName in class Descriptors.GenericDescriptor

getPackage

public String getPackage()

Get the proto package name. This is the package name given by the package statement in the .proto file, which differs from the Java package.

getOptions

public DescriptorProtos.FileOptions getOptions()

Get the FileOptions, defined in descriptor.proto.

getMessageTypes

public List<Descriptors.Descriptor> getMessageTypes()

Get a list of top-level message types declared in this file.

getMessageTypeCount

public int getMessageTypeCount()

getMessageType

public Descriptors.Descriptor getMessageType(int index)

getEnumTypes

public List<Descriptors.EnumDescriptor> getEnumTypes()

Get a list of top-level enum types declared in this file.

getEnumTypeCount

public int getEnumTypeCount()

getEnumType

public Descriptors.EnumDescriptor getEnumType(int index)

getServices

public List<Descriptors.ServiceDescriptor> getServices()

Get a list of top-level services declared in this file.

getServiceCount

public int getServiceCount()

getService

public Descriptors.ServiceDescriptor getService(int index)

getExtensions

public List<Descriptors.FieldDescriptor> getExtensions()

Get a list of top-level extensions declared in this file.

getExtensionCount

public int getExtensionCount()

getExtension

public Descriptors.FieldDescriptor getExtension(int index)

getDependencies

public List<Descriptors.FileDescriptor> getDependencies()

Get a list of this file's dependencies (imports).

getPublicDependencies

public List<Descriptors.FileDescriptor> getPublicDependencies()

Get a list of this file's public dependencies (public imports).

getEdition

DescriptorProtos.Edition getEdition()

Get the edition of the .proto file.

copyHeadingTo

public void copyHeadingTo(DescriptorProtos.FileDescriptorProto.Builder protoBuilder)

findMessageTypeByName

public Descriptors.Descriptor findMessageTypeByName(String name)

Find a message type in the file by name. Does not find nested types.

Parameters:

name - The unqualified type name to look for.

Returns:

The message type's descriptor, or null if not found.

findEnumTypeByName

public Descriptors.EnumDescriptor findEnumTypeByName(String name)

Find an enum type in the file by name. Does not find nested types.

Parameters:

name - The unqualified type name to look for.

Returns:

The enum type's descriptor, or null if not found.

findServiceByName

public Descriptors.ServiceDescriptor findServiceByName(String name)

Find a service type in the file by name.

Parameters:

name - The unqualified type name to look for.

Returns:

The service type's descriptor, or null if not found.

findExtensionByName

public Descriptors.FieldDescriptor findExtensionByName(String name)

Find an extension in the file by name. Does not find extensions nested inside message types.

Parameters:

name - The unqualified extension name to look for.

Returns:

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

buildFrom

public static Descriptors.FileDescriptor buildFrom(DescriptorProtos.FileDescriptorProto proto,
 Descriptors.FileDescriptor[] dependencies)
                                            throws Descriptors.DescriptorValidationException

Construct a FileDescriptor.

Parameters:

proto - the protocol message form of the FileDescriptort

dependencies - FileDescriptors corresponding to all of the file's dependencies.

Throws:

Descriptors.DescriptorValidationException - proto is not a valid descriptor. This can occur for a number of reasons; for instance, because a field has an undefined type or because two messages were defined with the same name.

buildFrom

public static Descriptors.FileDescriptor buildFrom(DescriptorProtos.FileDescriptorProto proto,
 Descriptors.FileDescriptor[] dependencies,
 boolean allowUnknownDependencies)
                                            throws Descriptors.DescriptorValidationException

Construct a FileDescriptor.

Parameters:

proto - the protocol message form of the FileDescriptor

dependencies - FileDescriptors corresponding to all of the file's dependencies

allowUnknownDependencies - if true, non-existing dependencies will be ignored and undefined message types will be replaced with a placeholder type. Undefined enum types still cause a DescriptorValidationException.

Throws:

Descriptors.DescriptorValidationException - proto is not a valid descriptor. This can occur for a number of reasons; for instance, because a field has an undefined type or because two messages were defined with the same name.

buildFrom

private static Descriptors.FileDescriptor buildFrom(DescriptorProtos.FileDescriptorProto proto,
 Descriptors.FileDescriptor[] dependencies,
 boolean allowUnknownDependencies,
 boolean allowUnresolvedFeatures)
                                             throws Descriptors.DescriptorValidationException

Throws:

Descriptors.DescriptorValidationException

latin1Cat

private static byte[] latin1Cat(String[] strings)

findDescriptors

private static Descriptors.FileDescriptor[] findDescriptors(Class<?> descriptorOuterClass,
 String[] dependencyClassNames,
 String[] dependencyFileNames)

internalBuildGeneratedFileFrom

@Deprecated
public static void internalBuildGeneratedFileFrom(String[] descriptorDataParts,
 Descriptors.FileDescriptor[] dependencies,
 Descriptors.FileDescriptor.InternalDescriptorAssigner descriptorAssigner)

Deprecated.

Any gencode which is using this method is far out of support and should be regenerated with a newer version of the protobuf compiler.

This method is for backward compatibility with generated code which passed an InternalDescriptorAssigner.

internalBuildGeneratedFileFrom

public static Descriptors.FileDescriptor internalBuildGeneratedFileFrom(String[] descriptorDataParts,
 Descriptors.FileDescriptor[] dependencies)

This method is to be called by generated code only. It is equivalent to buildFrom except that the FileDescriptorProto is encoded in protocol buffer wire format.

internalBuildGeneratedFileFrom

public static Descriptors.FileDescriptor internalBuildGeneratedFileFrom(String[] descriptorDataParts,
 Class<?> descriptorOuterClass,
 String[] dependencyClassNames,
 String[] dependencyFileNames)

This method is to be called by generated code only. It uses Java reflection to load the dependencies' descriptors.

internalUpdateFileDescriptor

public static void internalUpdateFileDescriptor(Descriptors.FileDescriptor descriptor,
 ExtensionRegistry registry)

This method is to be called by generated code only. It updates the FileDescriptorProto associated with the descriptor by parsing it again with the given ExtensionRegistry. This is needed to recognize custom options.

resolveAllFeaturesImmutable

public void resolveAllFeaturesImmutable()

resolveAllFeaturesInternal

private void resolveAllFeaturesInternal()
                                 throws Descriptors.DescriptorValidationException

This method is to be called by generated code only. It resolves features for the descriptor and all of its children.

Throws:

Descriptors.DescriptorValidationException

inferLegacyProtoFeatures

DescriptorProtos.FeatureSet inferLegacyProtoFeatures()

Overrides:

inferLegacyProtoFeatures in class Descriptors.GenericDescriptor

crossLink

private void crossLink()
                throws Descriptors.DescriptorValidationException

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

Throws:

Descriptors.DescriptorValidationException

setProto

private void setProto(DescriptorProtos.FileDescriptorProto proto)

Replace our DescriptorProtos.FileDescriptorProto with the given one, which is identical except that it might contain extensions that weren't present in the original. This method is needed for bootstrapping when a file defines custom options. The options may be defined in the file itself, so we can't actually parse them until we've constructed the descriptors, but to construct the descriptors we have to have parsed the descriptor protos. So, we have to parse the descriptor protos a second time after constructing the descriptors.