Class Descriptors

java.lang.Object

com.google.protobuf.Descriptors

@CheckReturnValue
public final class Descriptors
extends Object

Contains a collection of classes which describe protocol message types.

Every message type has a Descriptors.Descriptor, which lists all its fields and other information about a type. You can get a message type's descriptor by calling MessageType.getDescriptor(), or (given a message object of the type) message.getDescriptorForType(). Furthermore, each message is associated with a Descriptors.FileDescriptor for a relevant .proto file. You can obtain it by calling Descriptor.getFile(). A Descriptors.FileDescriptor contains descriptors for all the messages defined in that file, and file descriptors for all the imported .proto files.

Descriptors are built from DescriptorProtos, as defined in google/protobuf/descriptor.proto.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Descriptors.Descriptor	Describes a message type.
static class	Descriptors.DescriptorValidationException	Thrown when building descriptors fails because the source DescriptorProtos are not valid.
static final class	Descriptors.EnumDescriptor	Describes an enum type.
static final class	Descriptors.EnumValueDescriptor	Describes one value within an enum type.
static final class	Descriptors.FieldDescriptor	Describes a field of a message type.
static final class	Descriptors.FileDescriptor	Describes a .proto file, including everything defined within.
private static final class	Descriptors.FileDescriptorTables	A private helper class which contains lookup tables containing all the descriptors defined in a particular file.
static class	Descriptors.GenericDescriptor	All descriptors implement this to make it easier to implement tools like FileDescriptorTables.
static final class	Descriptors.MethodDescriptor	Describes one method within a service type.
static final class	Descriptors.OneofDescriptor	Describes a oneof of a message type.
static final class	Descriptors.ServiceDescriptor	Describes a service type.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Descriptors.Descriptor[]	EMPTY_DESCRIPTORS
private static final Descriptors.EnumDescriptor[]	EMPTY_ENUM_DESCRIPTORS
private static final Descriptors.FieldDescriptor[]	EMPTY_FIELD_DESCRIPTORS
private static final int[]	EMPTY_INT_ARRAY
private static final Descriptors.OneofDescriptor[]	EMPTY_ONEOF_DESCRIPTORS
private static final Descriptors.ServiceDescriptor[]	EMPTY_SERVICE_DESCRIPTORS
private static final ConcurrentHashMap<DescriptorProtos.FeatureSet, DescriptorProtos.FeatureSet>	FEATURE_CACHE
private static DescriptorProtos.FeatureSetDefaults	javaEditionDefaults
private static final Logger	logger

Constructor Summary

Constructors

Constructor	Description
Descriptors()

Method Summary

Modifier and Type	Method	Description
private static <T> T	binarySearch(T[] array, int size, ToIntFunction<T> getter, int number)
private static String	computeFullName(Descriptors.FileDescriptor file, Descriptors.Descriptor parent, String name)
(package private) static DescriptorProtos.FeatureSet	getEditionDefaults(DescriptorProtos.Edition edition)
(package private) static DescriptorProtos.FeatureSetDefaults	getJavaEditionDefaults()	Gets the default feature mappings used during the build.
private static DescriptorProtos.FeatureSet	internFeatures(DescriptorProtos.FeatureSet features)
(package private) static void	setTestJavaEditionDefaults(DescriptorProtos.FeatureSetDefaults defaults)	Sets the default feature mappings used during the build.

Methods inherited from class Object

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

Field Details

logger

private static final Logger logger

EMPTY_INT_ARRAY

private static final int[] EMPTY_INT_ARRAY

EMPTY_DESCRIPTORS

private static final Descriptors.Descriptor[] EMPTY_DESCRIPTORS

EMPTY_FIELD_DESCRIPTORS

private static final Descriptors.FieldDescriptor[] EMPTY_FIELD_DESCRIPTORS

EMPTY_ENUM_DESCRIPTORS

private static final Descriptors.EnumDescriptor[] EMPTY_ENUM_DESCRIPTORS

EMPTY_SERVICE_DESCRIPTORS

private static final Descriptors.ServiceDescriptor[] EMPTY_SERVICE_DESCRIPTORS

EMPTY_ONEOF_DESCRIPTORS

private static final Descriptors.OneofDescriptor[] EMPTY_ONEOF_DESCRIPTORS

FEATURE_CACHE

private static final ConcurrentHashMap<DescriptorProtos.FeatureSet, DescriptorProtos.FeatureSet> FEATURE_CACHE

javaEditionDefaults

private static volatile DescriptorProtos.FeatureSetDefaults javaEditionDefaults

Constructor Details

Descriptors

public Descriptors()

Method Details

setTestJavaEditionDefaults

static void setTestJavaEditionDefaults(DescriptorProtos.FeatureSetDefaults defaults)

Sets the default feature mappings used during the build. Exposed for tests.

getJavaEditionDefaults

static DescriptorProtos.FeatureSetDefaults getJavaEditionDefaults()

Gets the default feature mappings used during the build.

getEditionDefaults

static DescriptorProtos.FeatureSet getEditionDefaults(DescriptorProtos.Edition edition)

internFeatures

private static DescriptorProtos.FeatureSet internFeatures(DescriptorProtos.FeatureSet features)

computeFullName

private static String computeFullName(Descriptors.FileDescriptor file,
 Descriptors.Descriptor parent,
 String name)

Throws:

NullPointerException - if both `file` and `parent` are null.

binarySearch

private static <T> T binarySearch(T[] array,
 int size,
 ToIntFunction<T> getter,
 int number)