Package dev.cel.compiler

Class CelCompilerImpl.Builder

java.lang.Object

dev.cel.compiler.CelCompilerImpl.Builder

All Implemented Interfaces:

CelCompilerBuilder

Enclosing class:

CelCompilerImpl

public static final class CelCompilerImpl.Builder
extends java.lang.Object
implements CelCompilerBuilder

Builder for CelCompilerImpl

Method Summary

Modifier and Type	Method	Description
CelCompilerBuilder	addDeclarations(Decl... declarations)	Add variable and function declarations to the CEL environment.
CelCompilerBuilder	addDeclarations(java.lang.Iterable<Decl> declarations)	Add variable and function declarations to the CEL environment.
CelCompilerBuilder	addFileTypes(com.google.protobuf.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.
CelCompilerBuilder	addFileTypes(com.google.protobuf.Descriptors.FileDescriptor... fileDescriptors)	Add Descriptors.FileDescriptors to the use for type-checking, and for object creation at interpretation time.
CelCompilerBuilder	addFileTypes(java.lang.Iterable<com.google.protobuf.Descriptors.FileDescriptor> fileDescriptors)	Add Descriptors.FileDescriptors to the use for type-checking, and for object creation at interpretation time.
CelCompilerBuilder	addFunctionDeclarations(CelFunctionDecl... celFunctionDecls)	Add function declaration CelFunctionDecl to the CEL environment
CelCompilerBuilder	addFunctionDeclarations(java.lang.Iterable<CelFunctionDecl> celFunctionDecls)	Add function declaration CelFunctionDecl to the CEL environment
CelCompilerBuilder	addLibraries(CelCompilerLibrary... libraries)	Adds one or more libraries for parsing and type-checking.
CelCompilerBuilder	addLibraries(java.lang.Iterable<? extends CelCompilerLibrary> libraries)	Adds a collection of libraries for parsing and type-checking.
CelCompilerBuilder	addMacros(CelMacro... macros)	Registers the given macros, replacing any previous macros with the same key.
CelCompilerBuilder	addMacros(java.lang.Iterable<CelMacro> macros)	Registers the given macros, replacing any previous macros with the same key.
CelCompilerBuilder	addMessageTypes(com.google.protobuf.Descriptors.Descriptor... descriptors)	Add message Descriptors.Descriptors to the use for type-checking and object creation at interpretation time.
CelCompilerBuilder	addMessageTypes(java.lang.Iterable<com.google.protobuf.Descriptors.Descriptor> descriptors)	Add message Descriptors.Descriptors to the use for type-checking and object creation at interpretation time.
CelCompilerBuilder	addProtoTypeMasks(ProtoTypeMask... typeMasks)	Add one or more ProtoTypeMask values.
CelCompilerBuilder	addProtoTypeMasks(java.lang.Iterable<ProtoTypeMask> typeMasks)	Add one or more ProtoTypeMask values.
CelCompilerBuilder	addVar(java.lang.String name, CelType type)	Add a variable declaration with a given name and CelType.
CelCompilerBuilder	addVar(java.lang.String name, Type type)	Add a variable declaration with a given name and proto based Type.
CelCompilerBuilder	addVarDeclarations(CelVarDecl... celVarDecls)	Add variable declaration CelVarDecl to the CEL environment.
CelCompilerBuilder	addVarDeclarations(java.lang.Iterable<CelVarDecl> celVarDecls)	Add variable declaration CelVarDecl to the CEL environment.
CelCompilerImpl	build()	Build a new instance of the CelCompiler.
CelCompilerBuilder	setContainer(java.lang.String container)	Set the container name to use as the namespace for resolving CEL expression variables and functions.
CelCompilerBuilder	setOptions(CelOptions options)	Set the CelOptions used to enable fixes and features for this CEL instances.
CelCompilerBuilder	setProtoResultType(Type resultType)	Set the expected resultType in proto format described in checked.proto for the type-checked expression.
CelCompilerBuilder	setResultType(CelType resultType)	Set the expected resultType for the type-checked expression.
CelCompilerBuilder	setStandardDeclarations(CelStandardDeclarations standardDeclarations)	Override the standard declarations for the type-checker.
CelCompilerBuilder	setStandardEnvironmentEnabled(boolean value)	Enable or disable the standard CEL library functions and variables
CelCompilerBuilder	setStandardMacros(CelStandardMacro... macros)	Sets the macro set for the parser, replacing the macros from any prior call.
CelCompilerBuilder	setStandardMacros(java.lang.Iterable<CelStandardMacro> macros)	Sets the macro set for the parser, replacing the macros from any prior call.
CelCompilerBuilder	setTypeProvider(TypeProvider typeProvider)	Deprecated.
CelCompilerBuilder	setTypeProvider(CelTypeProvider celTypeProvider)	Set the celTypeProvider for use with type-checking expressions.

Methods inherited from class java.lang.Object

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

Method Detail

setOptions

public CelCompilerBuilder setOptions(CelOptions options)

Description copied from interface: CelCompilerBuilder

Set the CelOptions used to enable fixes and features for this CEL instances.

Specified by:

setOptions in interface CelCompilerBuilder

setStandardMacros

public CelCompilerBuilder setStandardMacros(CelStandardMacro... macros)

Description copied from interface: CelCompilerBuilder

Sets the macro set for the parser, replacing the macros from any prior call.

Specified by:

setStandardMacros in interface CelCompilerBuilder

setStandardMacros

public CelCompilerBuilder setStandardMacros(java.lang.Iterable<CelStandardMacro> macros)

Description copied from interface: CelCompilerBuilder

Sets the macro set for the parser, replacing the macros from any prior call.

Specified by:

setStandardMacros in interface CelCompilerBuilder

addMacros

public CelCompilerBuilder addMacros(CelMacro... macros)

Description copied from interface: CelCompilerBuilder

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

Specified by:

addMacros in interface CelCompilerBuilder

addMacros

public CelCompilerBuilder addMacros(java.lang.Iterable<CelMacro> macros)

Description copied from interface: CelCompilerBuilder

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

Specified by:

addMacros in interface CelCompilerBuilder

setContainer

public CelCompilerBuilder setContainer(java.lang.String container)

Description copied from interface: CelCompilerBuilder

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

Specified by:

setContainer in interface CelCompilerBuilder

addVar

public CelCompilerBuilder addVar(java.lang.String name,
                                 Type type)

Description copied from interface: CelCompilerBuilder

Add a variable declaration with a given name and proto based Type.

Specified by:

addVar in interface CelCompilerBuilder

addVar

public CelCompilerBuilder addVar(java.lang.String name,
                                 CelType type)

Description copied from interface: CelCompilerBuilder

Add a variable declaration with a given name and CelType.

Specified by:

addVar in interface CelCompilerBuilder

addDeclarations

public CelCompilerBuilder addDeclarations(Decl... declarations)

Description copied from interface: CelCompilerBuilder

Add variable and function declarations to the CEL environment.

Specified by:

addDeclarations in interface CelCompilerBuilder

addDeclarations

public CelCompilerBuilder addDeclarations(java.lang.Iterable<Decl> declarations)

Description copied from interface: CelCompilerBuilder

Add variable and function declarations to the CEL environment.

Specified by:

addDeclarations in interface CelCompilerBuilder

addFunctionDeclarations

public CelCompilerBuilder addFunctionDeclarations(CelFunctionDecl... celFunctionDecls)

Description copied from interface: CelCompilerBuilder

Add function declaration CelFunctionDecl to the CEL environment

Specified by:

addFunctionDeclarations in interface CelCompilerBuilder

addFunctionDeclarations

public CelCompilerBuilder addFunctionDeclarations(java.lang.Iterable<CelFunctionDecl> celFunctionDecls)

Description copied from interface: CelCompilerBuilder

Add function declaration CelFunctionDecl to the CEL environment

Specified by:

addFunctionDeclarations in interface CelCompilerBuilder

addVarDeclarations

public CelCompilerBuilder addVarDeclarations(CelVarDecl... celVarDecls)

Description copied from interface: CelCompilerBuilder

Add variable declaration CelVarDecl to the CEL environment.

Specified by:

addVarDeclarations in interface CelCompilerBuilder

addVarDeclarations

public CelCompilerBuilder addVarDeclarations(java.lang.Iterable<CelVarDecl> celVarDecls)

Description copied from interface: CelCompilerBuilder

Add variable declaration CelVarDecl to the CEL environment.

Specified by:

addVarDeclarations in interface CelCompilerBuilder

addProtoTypeMasks

public CelCompilerBuilder addProtoTypeMasks(ProtoTypeMask... typeMasks)

Description copied from interface: CelCompilerBuilder

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 to return the set of all fields declared on the protobuf type.

Specified by:

addProtoTypeMasks in interface CelCompilerBuilder

addProtoTypeMasks

public CelCompilerBuilder addProtoTypeMasks(java.lang.Iterable<ProtoTypeMask> typeMasks)

Description copied from interface: CelCompilerBuilder

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 to return the set of all fields declared on the protobuf type.

Specified by:

addProtoTypeMasks in interface CelCompilerBuilder

setResultType

public CelCompilerBuilder setResultType(CelType resultType)

Description copied from interface: CelCompilerBuilder

Set the expected resultType for the type-checked expression.

Specified by:

setResultType in interface CelCompilerBuilder

setProtoResultType

public CelCompilerBuilder setProtoResultType(Type resultType)

Description copied from interface: CelCompilerBuilder

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

Specified by:

setProtoResultType in interface CelCompilerBuilder

setTypeProvider

@Deprecated
public CelCompilerBuilder setTypeProvider(TypeProvider typeProvider)

Deprecated.

Description copied from interface: CelCompilerBuilder

Set the typeProvider for use with type-checking expressions.

Specified by:

setTypeProvider in interface CelCompilerBuilder

setTypeProvider

public CelCompilerBuilder setTypeProvider(CelTypeProvider celTypeProvider)

Description copied from interface: CelCompilerBuilder

Set the celTypeProvider for use with type-checking expressions.

Specified by:

setTypeProvider in interface CelCompilerBuilder

addMessageTypes

public CelCompilerBuilder addMessageTypes(com.google.protobuf.Descriptors.Descriptor... descriptors)

Description copied from interface: CelCompilerBuilder

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

Specified by:

addMessageTypes in interface CelCompilerBuilder

addMessageTypes

public CelCompilerBuilder addMessageTypes(java.lang.Iterable<com.google.protobuf.Descriptors.Descriptor> descriptors)

Description copied from interface: CelCompilerBuilder

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

Specified by:

addMessageTypes in interface CelCompilerBuilder

addFileTypes

public CelCompilerBuilder addFileTypes(com.google.protobuf.Descriptors.FileDescriptor... fileDescriptors)

Description copied from interface: CelCompilerBuilder

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

Specified by:

addFileTypes in interface CelCompilerBuilder

addFileTypes

public CelCompilerBuilder addFileTypes(java.lang.Iterable<com.google.protobuf.Descriptors.FileDescriptor> fileDescriptors)

Description copied from interface: CelCompilerBuilder

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

Specified by:

addFileTypes in interface CelCompilerBuilder

addFileTypes

public CelCompilerBuilder addFileTypes(com.google.protobuf.DescriptorProtos.FileDescriptorSet fileDescriptorSet)

Description copied from interface: CelCompilerBuilder

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

Specified by:

addFileTypes in interface CelCompilerBuilder

setStandardEnvironmentEnabled

public CelCompilerBuilder setStandardEnvironmentEnabled(boolean value)

Description copied from interface: CelCompilerBuilder

Enable or disable the standard CEL library functions and variables

Specified by:

setStandardEnvironmentEnabled in interface CelCompilerBuilder

setStandardDeclarations

public CelCompilerBuilder setStandardDeclarations(CelStandardDeclarations standardDeclarations)

Description copied from interface: CelCompilerBuilder

Override the standard declarations for the type-checker. This can be used to subset the standard environment to only expose the desired declarations to the type-checker. CelCompilerBuilder.setStandardEnvironmentEnabled(boolean) must be set to false for this to take effect.

Specified by:

setStandardDeclarations in interface CelCompilerBuilder

addLibraries

public CelCompilerBuilder addLibraries(CelCompilerLibrary... libraries)

Description copied from interface: CelCompilerBuilder

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

Specified by:

addLibraries in interface CelCompilerBuilder

addLibraries

public CelCompilerBuilder addLibraries(java.lang.Iterable<? extends CelCompilerLibrary> libraries)

Description copied from interface: CelCompilerBuilder

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

Specified by:

addLibraries in interface CelCompilerBuilder

build

@CheckReturnValue
public CelCompilerImpl build()

Description copied from interface: CelCompilerBuilder

Build a new instance of the CelCompiler.

Specified by:

build in interface CelCompilerBuilder