Package dev.cel.checker

Class CelCheckerLegacyImpl.Builder

java.lang.Object

dev.cel.checker.CelCheckerLegacyImpl.Builder

All Implemented Interfaces:

CelCheckerBuilder

Enclosing class:

CelCheckerLegacyImpl

public static final class CelCheckerLegacyImpl.Builder
extends java.lang.Object
implements CelCheckerBuilder

Builder class for the legacy CelChecker implementation.

Method Summary

Modifier and Type	Method	Description
CelCheckerBuilder	addDeclarations(dev.cel.expr.Decl... declarations)	Add variable and function declarations to the CEL environment.
CelCheckerBuilder	addDeclarations(java.lang.Iterable<dev.cel.expr.Decl> declarations)	Add variable and function declarations to the CEL environment.
CelCheckerBuilder	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.
CelCheckerBuilder	addFileTypes(com.google.protobuf.Descriptors.FileDescriptor... fileDescriptors)	Add Descriptors.FileDescriptors to the use for type-checking, and for object creation at interpretation time.
CelCheckerBuilder	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.
CelCheckerBuilder	addFunctionDeclarations(CelFunctionDecl... celFunctionDecls)	Add function declaration CelFunctionDecl to the CEL environment.
CelCheckerBuilder	addFunctionDeclarations(java.lang.Iterable<CelFunctionDecl> celFunctionDecls)	Add function declaration CelFunctionDecl to the CEL environment.
CelCheckerBuilder	addLibraries(CelCheckerLibrary... libraries)	Adds one or more libraries for parsing and type-checking.
CelCheckerBuilder	addLibraries(java.lang.Iterable<? extends CelCheckerLibrary> libraries)	Adds a collection of libraries for parsing and type-checking.
CelCheckerBuilder	addMessageTypes(com.google.protobuf.Descriptors.Descriptor... descriptors)	Add message Descriptors.Descriptors to the use for type-checking and object creation at interpretation time.
CelCheckerBuilder	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.
CelCheckerBuilder	addProtoTypeMasks(ProtoTypeMask... typeMasks)	Add one or more ProtoTypeMask values.
CelCheckerBuilder	addProtoTypeMasks(java.lang.Iterable<ProtoTypeMask> typeMasks)	Add one or more ProtoTypeMask values.
CelCheckerBuilder	addVarDeclarations(CelVarDecl... celVarDecls)	Add variable declaration CelVarDecl to the CEL environment.
CelCheckerBuilder	addVarDeclarations(java.lang.Iterable<CelVarDecl> celVarDecls)	Add variable declaration CelVarDecl to the CEL environment.
CelCheckerLegacyImpl	build()	Build a new instance of the CelChecker.
dev.cel.common.CelContainer	container()	Retrieves the currently configured CelContainer in the builder.
dev.cel.common.CelOptions	options()	Retrieves the currently configured CelOptions in the builder.
CelCheckerBuilder	setContainer(dev.cel.common.CelContainer container)	Set the CelContainer to use as the namespace for resolving CEL expression variables and functions.
CelCheckerBuilder	setOptions(dev.cel.common.CelOptions celOptions)	Set the CelOptions used to enable fixes and features for this CEL instances.
CelCheckerBuilder	setProtoResultType(dev.cel.expr.Type resultType)	Set the expected resultType in proto format described in checked.proto for the type-checked expression.
CelCheckerBuilder	setResultType(dev.cel.common.types.CelType resultType)	Set the expected resultType for the type-checked expression.
CelCheckerBuilder	setStandardDeclarations(CelStandardDeclarations standardDeclarations)	Override the standard declarations for the type-checker.
CelCheckerBuilder	setStandardEnvironmentEnabled(boolean value)	Enable or disable the standard CEL library functions and variables
CelCheckerBuilder	setTypeProvider(TypeProvider typeProvider)	Deprecated.
CelCheckerBuilder	setTypeProvider(dev.cel.common.types.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 CelCheckerBuilder setOptions(dev.cel.common.CelOptions celOptions)

Description copied from interface: CelCheckerBuilder

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

Specified by:

setOptions in interface CelCheckerBuilder

options

public dev.cel.common.CelOptions options()

Description copied from interface: CelCheckerBuilder

Retrieves the currently configured CelOptions in the builder.

Specified by:

options in interface CelCheckerBuilder

setContainer

public CelCheckerBuilder setContainer(dev.cel.common.CelContainer container)

Description copied from interface: CelCheckerBuilder

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

Specified by:

setContainer in interface CelCheckerBuilder

container

public dev.cel.common.CelContainer container()

Description copied from interface: CelCheckerBuilder

Retrieves the currently configured CelContainer in the builder.

Specified by:

container in interface CelCheckerBuilder

addDeclarations

public CelCheckerBuilder addDeclarations(dev.cel.expr.Decl... declarations)

Description copied from interface: CelCheckerBuilder

Add variable and function declarations to the CEL environment.

Specified by:

addDeclarations in interface CelCheckerBuilder

addDeclarations

public CelCheckerBuilder addDeclarations(java.lang.Iterable<dev.cel.expr.Decl> declarations)

Description copied from interface: CelCheckerBuilder

Add variable and function declarations to the CEL environment.

Specified by:

addDeclarations in interface CelCheckerBuilder

addFunctionDeclarations

@CanIgnoreReturnValue
public CelCheckerBuilder addFunctionDeclarations(CelFunctionDecl... celFunctionDecls)

Description copied from interface: CelCheckerBuilder

Add function declaration CelFunctionDecl to the CEL environment.

Specified by:

addFunctionDeclarations in interface CelCheckerBuilder

addFunctionDeclarations

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

Description copied from interface: CelCheckerBuilder

Add function declaration CelFunctionDecl to the CEL environment.

Specified by:

addFunctionDeclarations in interface CelCheckerBuilder

addVarDeclarations

public CelCheckerBuilder addVarDeclarations(CelVarDecl... celVarDecls)

Description copied from interface: CelCheckerBuilder

Add variable declaration CelVarDecl to the CEL environment.

Specified by:

addVarDeclarations in interface CelCheckerBuilder

addVarDeclarations

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

Description copied from interface: CelCheckerBuilder

Add variable declaration CelVarDecl to the CEL environment.

Specified by:

addVarDeclarations in interface CelCheckerBuilder

addProtoTypeMasks

public CelCheckerBuilder addProtoTypeMasks(ProtoTypeMask... typeMasks)

Description copied from interface: CelCheckerBuilder

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.

Specified by:

addProtoTypeMasks in interface CelCheckerBuilder

addProtoTypeMasks

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

Description copied from interface: CelCheckerBuilder

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.

Specified by:

addProtoTypeMasks in interface CelCheckerBuilder

setResultType

public CelCheckerBuilder setResultType(dev.cel.common.types.CelType resultType)

Description copied from interface: CelCheckerBuilder

Set the expected resultType for the type-checked expression.

Specified by:

setResultType in interface CelCheckerBuilder

setProtoResultType

public CelCheckerBuilder setProtoResultType(dev.cel.expr.Type resultType)

Description copied from interface: CelCheckerBuilder

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

Specified by:

setProtoResultType in interface CelCheckerBuilder

setTypeProvider

@Deprecated
public CelCheckerBuilder setTypeProvider(TypeProvider typeProvider)

Deprecated.

Description copied from interface: CelCheckerBuilder

Set the typeProvider for use with type-checking expressions.

Specified by:

setTypeProvider in interface CelCheckerBuilder

setTypeProvider

public CelCheckerBuilder setTypeProvider(dev.cel.common.types.CelTypeProvider celTypeProvider)

Description copied from interface: CelCheckerBuilder

Set the celTypeProvider for use with type-checking expressions.

Specified by:

setTypeProvider in interface CelCheckerBuilder

addMessageTypes

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

Description copied from interface: CelCheckerBuilder

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

Specified by:

addMessageTypes in interface CelCheckerBuilder

addMessageTypes

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

Description copied from interface: CelCheckerBuilder

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

Specified by:

addMessageTypes in interface CelCheckerBuilder

addFileTypes

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

Description copied from interface: CelCheckerBuilder

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

Specified by:

addFileTypes in interface CelCheckerBuilder

addFileTypes

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

Description copied from interface: CelCheckerBuilder

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

Specified by:

addFileTypes in interface CelCheckerBuilder

addFileTypes

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

Description copied from interface: CelCheckerBuilder

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 CelCheckerBuilder

setStandardEnvironmentEnabled

public CelCheckerBuilder setStandardEnvironmentEnabled(boolean value)

Description copied from interface: CelCheckerBuilder

Enable or disable the standard CEL library functions and variables

Specified by:

setStandardEnvironmentEnabled in interface CelCheckerBuilder

setStandardDeclarations

public CelCheckerBuilder setStandardDeclarations(CelStandardDeclarations standardDeclarations)

Description copied from interface: CelCheckerBuilder

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. CelCheckerBuilder.setStandardEnvironmentEnabled(boolean) must be set to false for this to take effect.

Specified by:

setStandardDeclarations in interface CelCheckerBuilder

addLibraries

public CelCheckerBuilder addLibraries(CelCheckerLibrary... libraries)

Description copied from interface: CelCheckerBuilder

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

Specified by:

addLibraries in interface CelCheckerBuilder

addLibraries

public CelCheckerBuilder addLibraries(java.lang.Iterable<? extends CelCheckerLibrary> libraries)

Description copied from interface: CelCheckerBuilder

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

Specified by:

addLibraries in interface CelCheckerBuilder

build

@CheckReturnValue
public CelCheckerLegacyImpl build()

Description copied from interface: CelCheckerBuilder

Build a new instance of the CelChecker.

Specified by:

build in interface CelCheckerBuilder