Package dev.cel.bundle

Interface CelBuilder

public interface CelBuilder

Interface for building an instance of Cel.

Method Summary

Modifier and Type	Method	Description
CelBuilder	addCompilerLibraries(CelCompilerLibrary... libraries)	Adds one or more libraries for parsing and type-checking.
CelBuilder	addCompilerLibraries(java.lang.Iterable<CelCompilerLibrary> libraries)	Adds a collection of libraries for parsing and type-checking.
CelBuilder	addDeclarations(Decl... declarations)	Add variable and function declarations to the CEL environment.
CelBuilder	addDeclarations(java.lang.Iterable<Decl> declarations)	Add variable and function declarations to the CEL environment.
CelBuilder	addFileTypes(DescriptorProtos.FileDescriptorSet fileDescriptorSet)	Add all of the Descriptors.FileDescriptors in a FileDescriptorSet to the use for type-checking, and for object creation at interpretation time.
CelBuilder	addFileTypes(Descriptors.FileDescriptor... fileDescriptors)	Add Descriptors.FileDescriptors to the use for type-checking, and for object creation at interpretation time.
CelBuilder	addFileTypes(java.lang.Iterable<Descriptors.FileDescriptor> fileDescriptors)	Add Descriptors.FileDescriptors to the use for type-checking, and for object creation at interpretation time.
CelBuilder	addFunctionBindings(CelRuntime.CelFunctionBinding... bindings)	Add one or more CelRuntime.CelFunctionBinding objects to the CEL runtime.
CelBuilder	addFunctionBindings(java.lang.Iterable<CelRuntime.CelFunctionBinding> bindings)	Bind a collection of CelRuntime.CelFunctionBinding objects to the runtime.
CelBuilder	addFunctionDeclarations(CelFunctionDecl... celFunctionDecls)	Add function declaration CelFunctionDecl to the CEL environment.
CelBuilder	addFunctionDeclarations(java.lang.Iterable<CelFunctionDecl> celFunctionDecls)	Add function declaration CelFunctionDecl to the CEL environment.
CelBuilder	addMacros(CelMacro... macros)	Registers the given macros, replacing any previous macros with the same key.
CelBuilder	addMacros(java.lang.Iterable<CelMacro> macros)	Registers the given macros, replacing any previous macros with the same key.
CelBuilder	addMessageTypes(Descriptors.Descriptor... descriptors)	Add message Descriptors.Descriptors to the use for type-checking and object creation at interpretation time.
CelBuilder	addMessageTypes(java.lang.Iterable<Descriptors.Descriptor> descriptors)	Add message Descriptors.Descriptors to the use for type-checking and object creation at interpretation time.
CelBuilder	addProtoTypeMasks(ProtoTypeMask... typeMasks)	Add one or more ProtoTypeMask values.
CelBuilder	addProtoTypeMasks(java.lang.Iterable<ProtoTypeMask> typeMasks)	Add one or more ProtoTypeMask values.
CelBuilder	addRuntimeLibraries(CelRuntimeLibrary... libraries)	Adds one or more libraries for runtime.
CelBuilder	addRuntimeLibraries(java.lang.Iterable<CelRuntimeLibrary> libraries)	Adds a collection of libraries for runtime.
CelBuilder	addVar(java.lang.String name, CelType type)	Add a variable declaration with a given name and CelType.
CelBuilder	addVar(java.lang.String name, Type type)	Add a variable declaration with a given name and Type.
CelBuilder	addVarDeclarations(CelVarDecl... celVarDecls)	Add variable declaration CelVarDecl to the CEL environment.
CelBuilder	addVarDeclarations(java.lang.Iterable<CelVarDecl> celVarDecls)	Add variable declaration CelVarDecl to the CEL environment.
Cel	build()	Construct a new Cel instance from the provided configuration.
CelBuilder	setContainer(java.lang.String container)	Set the container name to use as the namespace for resolving CEL expression variables and functions.
CelBuilder	setExtensionRegistry(ExtensionRegistry extensionRegistry)	Sets a proto ExtensionRegistry to assist with unpacking Any messages containing a proto2 extension field.
CelBuilder	setOptions(CelOptions options)	Set the CelOptions used to enable fixes and feautres for this CEL instance.
CelBuilder	setProtoResultType(Type resultType)	Set the expected resultType in proto format described in checked.proto for the type-checked expression.
CelBuilder	setResultType(CelType resultType)	Set the expected resultType for the type-checked expression.
CelBuilder	setStandardEnvironmentEnabled(boolean value)	Enable or disable the standard CEL library functions and variables
CelBuilder	setStandardMacros(CelStandardMacro... macros)	Set the CelStandardMacro values for use with this instance.
CelBuilder	setStandardMacros(java.lang.Iterable<CelStandardMacro> macros)	Set the CelStandardMacro values for use with this instance.
CelBuilder	setTypeFactory(java.util.function.Function<java.lang.String,Message.Builder> typeFactory)	Set a custom type factory for the runtime.
CelBuilder	setTypeProvider(TypeProvider typeProvider)	Deprecated. Use setTypeProvider(CelTypeProvider) instead.
CelBuilder	setTypeProvider(CelTypeProvider celTypeProvider)	Set the celTypeProvider for use with type-checking expressions.
CelBuilder	setValueProvider(CelValueProvider celValueProvider)	Sets the celValueProvider for resolving values during evaluation.

Method Detail

setOptions

@CanIgnoreReturnValue
CelBuilder setOptions(CelOptions options)

Set the CelOptions used to enable fixes and feautres for this CEL instance.

setStandardMacros

@CanIgnoreReturnValue
CelBuilder setStandardMacros(CelStandardMacro... macros)

Set the CelStandardMacro values for use with this instance.

setStandardMacros

@CanIgnoreReturnValue
CelBuilder setStandardMacros(java.lang.Iterable<CelStandardMacro> macros)

Set the CelStandardMacro values for use with this instance.

addMacros

@CanIgnoreReturnValue
CelBuilder addMacros(CelMacro... macros)

Registers the given macros, replacing any previous macros with the same key.

Use this to register a set of user-defined custom macro implementation for the parser. For registering macros defined as part of CEL standard library, use setStandardMacros(dev.cel.parser.CelStandardMacro...) instead.

Custom macros should not use the same function names as the ones found in CelStandardMacro (ex: has, all, exists, etc.). Build method will throw if both standard macros and custom macros are set with the same name.

addMacros

@CanIgnoreReturnValue
CelBuilder addMacros(java.lang.Iterable<CelMacro> macros)

Registers the given macros, replacing any previous macros with the same key.

Use this to register a set of user-defined custom macro implementation for the parser. For registering macros defined as part of CEL standard library, use setStandardMacros(dev.cel.parser.CelStandardMacro...) instead.

Custom macros should not use the same function names as the ones found in CelStandardMacro (ex: has, all, exists, etc.). Build method will throw if both standard macros and custom macros are set with the same name.

setContainer

@CanIgnoreReturnValue
CelBuilder setContainer(java.lang.String container)

Set the container name to use as the namespace for resolving CEL expression variables and functions.

addVar

@CanIgnoreReturnValue
CelBuilder addVar(java.lang.String name,
                  Type type)

Add a variable declaration with a given name and Type.

addVar

@CanIgnoreReturnValue
CelBuilder addVar(java.lang.String name,
                  CelType type)

Add a variable declaration with a given name and CelType.

addDeclarations

@CanIgnoreReturnValue
CelBuilder addDeclarations(Decl... declarations)

Add variable and function declarations to the CEL environment.

addDeclarations

@CanIgnoreReturnValue
CelBuilder addDeclarations(java.lang.Iterable<Decl> declarations)

Add variable and function declarations to the CEL environment.

addFunctionDeclarations

@CanIgnoreReturnValue
CelBuilder addFunctionDeclarations(CelFunctionDecl... celFunctionDecls)

Add function declaration CelFunctionDecl to the CEL environment.

addFunctionDeclarations

@CanIgnoreReturnValue
CelBuilder addFunctionDeclarations(java.lang.Iterable<CelFunctionDecl> celFunctionDecls)

Add function declaration CelFunctionDecl to the CEL environment.

addVarDeclarations

@CanIgnoreReturnValue
CelBuilder addVarDeclarations(CelVarDecl... celVarDecls)

Add variable declaration CelVarDecl to the CEL environment.

addVarDeclarations

@CanIgnoreReturnValue
CelBuilder addVarDeclarations(java.lang.Iterable<CelVarDecl> celVarDecls)

Add variable declaration CelVarDecl to the CEL environment.

addProtoTypeMasks

@CanIgnoreReturnValue
CelBuilder addProtoTypeMasks(ProtoTypeMask... typeMasks)

Add one or more ProtoTypeMask values. The ProtoTypeMask values will be used to compute a set of Decl values using a protobuf message's fields as the names and types of the variables if ProtoTypeMask.fieldsAreVariableDeclarations() is true.

Note, this feature may not work with custom TypeProvider implementations out of the box, as it requires the implementation of TypeProvider.lookupFieldNames(dev.cel.expr.Type) to return the set of all fields declared on the protobuf type.

addProtoTypeMasks

@CanIgnoreReturnValue
CelBuilder addProtoTypeMasks(java.lang.Iterable<ProtoTypeMask> typeMasks)

Add one or more ProtoTypeMask values. The ProtoTypeMask values will be used to compute a set of Decl values using a protobuf message's fields as the names and types of the variables if ProtoTypeMask.fieldsAreVariableDeclarations() is true.

Note, this feature may not work with custom TypeProvider implementations out of the box, as it requires the implementation of TypeProvider.lookupFieldNames(dev.cel.expr.Type) to return the set of all fields declared on the protobuf type.

addFunctionBindings

@CanIgnoreReturnValue
CelBuilder addFunctionBindings(CelRuntime.CelFunctionBinding... bindings)

Add one or more CelRuntime.CelFunctionBinding objects to the CEL runtime.

Functions with duplicate overload ids will be replaced in favor of the new overload.

addFunctionBindings

@CanIgnoreReturnValue
CelBuilder addFunctionBindings(java.lang.Iterable<CelRuntime.CelFunctionBinding> bindings)

Bind a collection of CelRuntime.CelFunctionBinding objects to the runtime.

Functions with duplicate overload ids will be replaced in favor of the new overload.

setResultType

@CanIgnoreReturnValue
CelBuilder setResultType(CelType resultType)

Set the expected resultType for the type-checked expression.

setProtoResultType

@CanIgnoreReturnValue
CelBuilder setProtoResultType(Type resultType)

Set the expected resultType in proto format described in checked.proto for the type-checked expression.

setTypeFactory

@CanIgnoreReturnValue
CelBuilder setTypeFactory(java.util.function.Function<java.lang.String,Message.Builder> typeFactory)

Set a custom type factory for the runtime.

Note: it is valid to combine type factory methods within the runtime. Only the options which have been configured will be used.

The type creation search order is as follows:

• Custom type factory (setTypeFactory(java.util.function.Function<java.lang.String, com.google.protobuf.Message.Builder>))
• Custom descriptor set {addMessageTypes(com.google.protobuf.Descriptors.Descriptor...))

setValueProvider

@CanIgnoreReturnValue
CelBuilder setValueProvider(CelValueProvider celValueProvider)

Sets the celValueProvider for resolving values during evaluation. The provided value provider will be used first before falling back to the built-in ProtoMessageValueProvider for resolving protobuf messages.

Note that CelOptions.enableCelValue() must be enabled or this method will be a no-op.

setTypeProvider

@CanIgnoreReturnValue
@Deprecated
CelBuilder setTypeProvider(TypeProvider typeProvider)

Deprecated.

Use setTypeProvider(CelTypeProvider) instead.

Set the typeProvider for use with type-checking expressions.

setTypeProvider

@CanIgnoreReturnValue
CelBuilder setTypeProvider(CelTypeProvider celTypeProvider)

Set the celTypeProvider for use with type-checking expressions.

addMessageTypes

@CanIgnoreReturnValue
CelBuilder addMessageTypes(Descriptors.Descriptor... descriptors)

Add message Descriptors.Descriptors to the use for type-checking and object creation at interpretation time.

This method may be safely combined with setTypeFactory(java.util.function.Function<java.lang.String, com.google.protobuf.Message.Builder>), setTypeProvider(dev.cel.checker.TypeProvider), and addFileTypes(com.google.protobuf.Descriptors.FileDescriptor...) calls.

If either a typeFactory or typeProvider are configured, these classes will take precedence over any dynamic resolution of data related to the descriptors.

addMessageTypes

@CanIgnoreReturnValue
CelBuilder addMessageTypes(java.lang.Iterable<Descriptors.Descriptor> descriptors)

Add message Descriptors.Descriptors to the use for type-checking and object creation at interpretation time.

This method may be safely combined with setTypeFactory(java.util.function.Function<java.lang.String, com.google.protobuf.Message.Builder>), setTypeProvider(dev.cel.checker.TypeProvider), and addFileTypes(com.google.protobuf.Descriptors.FileDescriptor...) calls.

If either a typeFactory or typeProvider are configured, these classes will take precedence over any dynamic resolution of data related to the descriptors.

addFileTypes

@CanIgnoreReturnValue
CelBuilder addFileTypes(Descriptors.FileDescriptor... fileDescriptors)

Add Descriptors.FileDescriptors to the use for type-checking, and for object creation at interpretation time.

This method may be safely combined with setTypeFactory(java.util.function.Function<java.lang.String, com.google.protobuf.Message.Builder>), setTypeProvider(dev.cel.checker.TypeProvider), and addMessageTypes(com.google.protobuf.Descriptors.Descriptor...) calls.

If either a typeFactory or typeProvider are configured, these classes will take precedence over any dynamic resolution of data related to the descriptors.

addFileTypes

@CanIgnoreReturnValue
CelBuilder addFileTypes(java.lang.Iterable<Descriptors.FileDescriptor> fileDescriptors)

Add Descriptors.FileDescriptors to the use for type-checking, and for object creation at interpretation time.

This method may be safely combined with setTypeFactory(java.util.function.Function<java.lang.String, com.google.protobuf.Message.Builder>), setTypeProvider(dev.cel.checker.TypeProvider), and addMessageTypes(com.google.protobuf.Descriptors.Descriptor...) calls.

If either a typeFactory or typeProvider are configured, these classes will take precedence over any dynamic resolution of data related to the descriptors.

addFileTypes

@CanIgnoreReturnValue
CelBuilder addFileTypes(DescriptorProtos.FileDescriptorSet fileDescriptorSet)

Add all of the Descriptors.FileDescriptors in a FileDescriptorSet to the use for type-checking, and for object creation at interpretation time.

This method may be safely combined with setTypeFactory(java.util.function.Function<java.lang.String, com.google.protobuf.Message.Builder>), setTypeProvider(dev.cel.checker.TypeProvider), and addMessageTypes(com.google.protobuf.Descriptors.Descriptor...) calls.

If either a typeFactory or typeProvider are configured, these classes will take precedence over any dynamic resolution of data related to the descriptors.

setStandardEnvironmentEnabled

@CanIgnoreReturnValue
CelBuilder setStandardEnvironmentEnabled(boolean value)

Enable or disable the standard CEL library functions and variables

addCompilerLibraries

@CanIgnoreReturnValue
CelBuilder addCompilerLibraries(CelCompilerLibrary... libraries)

Adds one or more libraries for parsing and type-checking.

addCompilerLibraries

@CanIgnoreReturnValue
CelBuilder addCompilerLibraries(java.lang.Iterable<CelCompilerLibrary> libraries)

Adds a collection of libraries for parsing and type-checking.

addRuntimeLibraries

@CanIgnoreReturnValue
CelBuilder addRuntimeLibraries(CelRuntimeLibrary... libraries)

Adds one or more libraries for runtime.

addRuntimeLibraries

@CanIgnoreReturnValue
CelBuilder addRuntimeLibraries(java.lang.Iterable<CelRuntimeLibrary> libraries)

Adds a collection of libraries for runtime.

setExtensionRegistry

@CanIgnoreReturnValue
CelBuilder setExtensionRegistry(ExtensionRegistry extensionRegistry)

Sets a proto ExtensionRegistry to assist with unpacking Any messages containing a proto2 extension field.

build

Cel build()

Construct a new Cel instance from the provided configuration.