Method Detail

• toProto

  public DescriptorProtos.FileDescriptorProto toProto()

  Convert the descriptor to its protocol message representation.

• getName

  public String getName()

  Get the file name.

• getFile

  public Descriptors.FileDescriptor getFile()

  Returns this object.

• getFullName

  public String getFullName()

  Returns the same as getName().

• 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.

• getEnumTypes

  public List<Descriptors.EnumDescriptor> getEnumTypes()

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

• getServices

  public List<Descriptors.ServiceDescriptor> getServices()

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

• getExtensions

  public List<Descriptors.FieldDescriptor> getExtensions()

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

• 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).

• 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 FileDescriptor.

  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, e.g. because a field has an undefined type or because two messages were defined with the same name.

• internalBuildGeneratedFileFrom

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

  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 void internalBuildGeneratedFileFrom(String[] descriptorDataParts,
                                                    Class<?> descriptorOuterClass,
                                                    String[] dependencies,
                                                    String[] dependencyFileNames,
                                                    Descriptors.FileDescriptor.InternalDescriptorAssigner descriptorAssigner)

  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 is used to update the FileDescriptorProto associated with the descriptor by parsing it again with the given ExtensionRegistry. This is needed to recognize custom options.