public static final class Descriptors.FileDescriptor extends Object
.proto
file, including everything defined within.Modifier and Type | Class and Description |
---|---|
static interface |
Descriptors.FileDescriptor.InternalDescriptorAssigner
This class should be used by generated code only.
|
Modifier and Type | Method and Description |
---|---|
static Descriptors.FileDescriptor |
buildFrom(DescriptorProtos.FileDescriptorProto proto,
Descriptors.FileDescriptor[] dependencies)
Construct a
FileDescriptor . |
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).
|
List<Descriptors.EnumDescriptor> |
getEnumTypes()
Get a list of top-level enum types declared in this file.
|
List<Descriptors.FieldDescriptor> |
getExtensions()
Get a list of top-level extensions declared in this file.
|
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.
|
List<Descriptors.ServiceDescriptor> |
getServices()
Get a list of top-level services declared in this file.
|
static void |
internalBuildGeneratedFileFrom(String[] descriptorDataParts,
Descriptors.FileDescriptor[] dependencies,
Descriptors.FileDescriptor.InternalDescriptorAssigner descriptorAssigner)
This method is to be called by generated code only.
|
DescriptorProtos.FileDescriptorProto |
toProto()
Convert the descriptor to its protocol message representation.
|
public DescriptorProtos.FileDescriptorProto toProto()
public String getName()
public String getPackage()
package
statement in the .proto
file, which differs
from the Java package.public DescriptorProtos.FileOptions getOptions()
FileOptions
, defined in descriptor.proto
.public List<Descriptors.Descriptor> getMessageTypes()
public List<Descriptors.EnumDescriptor> getEnumTypes()
public List<Descriptors.ServiceDescriptor> getServices()
public List<Descriptors.FieldDescriptor> getExtensions()
public List<Descriptors.FileDescriptor> getDependencies()
public Descriptors.Descriptor findMessageTypeByName(String name)
name
- The unqualified type name to look for.null
if not found.public Descriptors.EnumDescriptor findEnumTypeByName(String name)
name
- The unqualified type name to look for.null
if not found.public Descriptors.ServiceDescriptor findServiceByName(String name)
name
- The unqualified type name to look for.null
if not found.public Descriptors.FieldDescriptor findExtensionByName(String name)
name
- The unqualified extension name to look for.null
if not found.public static Descriptors.FileDescriptor buildFrom(DescriptorProtos.FileDescriptorProto proto, Descriptors.FileDescriptor[] dependencies) throws Descriptors.DescriptorValidationException
FileDescriptor
.proto
- The protocol message form of the FileDescriptor.dependencies
- FileDescriptor
s corresponding to all of
the file's dependencies, in the exact order listed
in proto
.Descriptors.DescriptorValidationException
- proto
is not a valid
descriptor. This can occur for a number of reasons, e.g.
because a field has an undefined type or because two messages
were defined with the same name.public static void internalBuildGeneratedFileFrom(String[] descriptorDataParts, Descriptors.FileDescriptor[] dependencies, Descriptors.FileDescriptor.InternalDescriptorAssigner descriptorAssigner)
buildFrom
except that the FileDescriptorProto
is
encoded in protocol buffer wire format.Copyright © 2008-2012. All Rights Reserved.