Package dev.cel.checker

Class DescriptorTypeProvider

java.lang.Object

dev.cel.checker.DescriptorTypeProvider

All Implemented Interfaces:

TypeProvider

@Immutable
@Internal
public class DescriptorTypeProvider
extends java.lang.Object
implements TypeProvider

The DescriptorTypeProvider provides type information for one or more Descriptors.Descriptor instances of proto messages.

TODO: Unify implementation across the runtime (i.e: DescriptorMessageProvider) and the compilation. This class can likely be eliminated as part of the work.

CEL Library Internals. Do Not Use.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DescriptorTypeProvider.EnumValueDef	Value object for an enum DescriptorTypeProvider.EnumValueDef.name() and DescriptorTypeProvider.EnumValueDef.value().
protected static class	DescriptorTypeProvider.FieldDef	Value object for a proto-based field definition.
protected static class	DescriptorTypeProvider.MapEntryDef	Value object for Map entry TypeDef information.
protected static class	DescriptorTypeProvider.SymbolTable	Helper class to construct a symbol table for messages, enums, and their respective declarations.
protected static class	DescriptorTypeProvider.TypeDef	Value object for a proto-based primitive, message, or enum definition.

Nested classes/interfaces inherited from interface dev.cel.checker.TypeProvider

TypeProvider.CombinedTypeProvider, TypeProvider.ExtensionFieldType, TypeProvider.FieldType

Constructor Summary

Constructors

Constructor	Description
DescriptorTypeProvider()	Constructs the empty provider, which will resolve nothing.
DescriptorTypeProvider(DescriptorProtos.FileDescriptorSet descriptorSet)	Constructs a provider based on the given file descriptor set proto, as it is emitted by the protocol compiler.
DescriptorTypeProvider(java.lang.Iterable<Descriptors.Descriptor> descriptors)
DescriptorTypeProvider(java.util.Collection<Descriptors.FileDescriptor> fileDescriptors)

Method Summary

Modifier and Type	Method	Description
@Nullable java.lang.Integer	lookupEnumValue(java.lang.String enumName)	Lookup the Integer enum value given an enumName.
@Nullable TypeProvider.ExtensionFieldType	lookupExtensionType(java.lang.String extensionName)	Lookup the FieldType of the named extension (specified using its full path).
@Nullable com.google.common.collect.ImmutableSet<java.lang.String>	lookupFieldNames(Type type)	Returns the field names associated with the given Type.
@Nullable TypeProvider.FieldType	lookupFieldType(Type type, java.lang.String fieldName)	Lookup the FieldType for a fieldName within a type.
@Nullable Type	lookupType(java.lang.String typeName)	Lookup the a Type given a qualified typeName.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.cel.checker.TypeProvider

lookupCelType, lookupFieldType

Constructor Detail

DescriptorTypeProvider

public DescriptorTypeProvider()

Constructs the empty provider, which will resolve nothing.

DescriptorTypeProvider

public DescriptorTypeProvider(DescriptorProtos.FileDescriptorSet descriptorSet)

Constructs a provider based on the given file descriptor set proto, as it is emitted by the protocol compiler.

DescriptorTypeProvider

public DescriptorTypeProvider(java.util.Collection<Descriptors.FileDescriptor> fileDescriptors)

DescriptorTypeProvider

public DescriptorTypeProvider(java.lang.Iterable<Descriptors.Descriptor> descriptors)

Method Detail

lookupType

public @Nullable Type lookupType(java.lang.String typeName)

Description copied from interface: TypeProvider

Lookup the a Type given a qualified typeName. Returns null if not found.

Specified by:

lookupType in interface TypeProvider

lookupEnumValue

public @Nullable java.lang.Integer lookupEnumValue(java.lang.String enumName)

Description copied from interface: TypeProvider

Lookup the Integer enum value given an enumName. Returns null if not found.

Specified by:

lookupEnumValue in interface TypeProvider

lookupFieldType

public @Nullable TypeProvider.FieldType lookupFieldType(Type type,
                                                        java.lang.String fieldName)

Description copied from interface: TypeProvider

Lookup the FieldType for a fieldName within a type. Returns null if not found.

The FieldType return value will indicate the type of the field and whether presence check is supported via the ('has') macro.

Specified by:

lookupFieldType in interface TypeProvider

lookupFieldNames

public @Nullable com.google.common.collect.ImmutableSet<java.lang.String> lookupFieldNames(Type type)

Description copied from interface: TypeProvider

Returns the field names associated with the given Type.

If the type is not a message type, or the type is not found, the result is null.

Specified by:

lookupFieldNames in interface TypeProvider

lookupExtensionType

public @Nullable TypeProvider.ExtensionFieldType lookupExtensionType(java.lang.String extensionName)

Description copied from interface: TypeProvider

Lookup the FieldType of the named extension (specified using its full path). Returns null if not found.

Specified by:

lookupExtensionType in interface TypeProvider