|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.google.protobuf.Descriptors.FileDescriptor
public static final class Descriptors.FileDescriptor
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 | |
---|---|
static interface |
Descriptors.FileDescriptor.InternalDescriptorAssigner
This class should be used by generated code only. |
Method Summary | |
---|---|
static Descriptors.FileDescriptor |
buildFrom(DescriptorProtos.FileDescriptorProto proto,
Descriptors.FileDescriptor[] dependencies)
Construct a FileDescriptor . |
Descriptors.EnumDescriptor |
findEnumTypeByName(java.lang.String name)
Find an enum type in the file by name. |
Descriptors.FieldDescriptor |
findExtensionByName(java.lang.String name)
Find an extension in the file by name. |
Descriptors.Descriptor |
findMessageTypeByName(java.lang.String name)
Find a message type in the file by name. |
Descriptors.ServiceDescriptor |
findServiceByName(java.lang.String name)
Find a service type in the file by name. |
java.util.List<Descriptors.FileDescriptor> |
getDependencies()
Get a list of this file's dependencies (imports). |
java.util.List<Descriptors.EnumDescriptor> |
getEnumTypes()
Get a list of top-level enum types declared in this file. |
java.util.List<Descriptors.FieldDescriptor> |
getExtensions()
Get a list of top-level extensions declared in this file. |
java.util.List<Descriptors.Descriptor> |
getMessageTypes()
Get a list of top-level message types declared in this file. |
java.lang.String |
getName()
Get the file name. |
DescriptorProtos.FileOptions |
getOptions()
Get the FileOptions , defined in descriptor.proto . |
java.lang.String |
getPackage()
Get the proto package name. |
java.util.List<Descriptors.ServiceDescriptor> |
getServices()
Get a list of top-level services declared in this file. |
static void |
internalBuildGeneratedFileFrom(java.lang.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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public DescriptorProtos.FileDescriptorProto toProto()
public java.lang.String getName()
public java.lang.String getPackage()
package
statement in the .proto
file, which differs
from the Java package.
public DescriptorProtos.FileOptions getOptions()
FileOptions
, defined in descriptor.proto
.
public java.util.List<Descriptors.Descriptor> getMessageTypes()
public java.util.List<Descriptors.EnumDescriptor> getEnumTypes()
public java.util.List<Descriptors.ServiceDescriptor> getServices()
public java.util.List<Descriptors.FieldDescriptor> getExtensions()
public java.util.List<Descriptors.FileDescriptor> getDependencies()
public Descriptors.Descriptor findMessageTypeByName(java.lang.String name)
name
- The unqualified type name to look for.
null
if not found.public Descriptors.EnumDescriptor findEnumTypeByName(java.lang.String name)
name
- The unqualified type name to look for.
null
if not found.public Descriptors.ServiceDescriptor findServiceByName(java.lang.String name)
name
- The unqualified type name to look for.
null
if not found.public Descriptors.FieldDescriptor findExtensionByName(java.lang.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(java.lang.String[] descriptorDataParts, Descriptors.FileDescriptor[] dependencies, Descriptors.FileDescriptor.InternalDescriptorAssigner descriptorAssigner)
buildFrom
except that the FileDescriptorProto
is
encoded in protocol buffer wire format.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |