dev.cel.checker.CelCheckerBuilder Maven / Gradle / Ivy
Show all versions of validators Show documentation
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package dev.cel.checker;
import dev.cel.expr.Decl;
import dev.cel.expr.Type;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.errorprone.annotations.CheckReturnValue;
import com.google.protobuf.DescriptorProtos.FileDescriptorSet;
import com.google.protobuf.Descriptors.Descriptor;
import com.google.protobuf.Descriptors.FileDescriptor;
import dev.cel.common.CelFunctionDecl;
import dev.cel.common.CelOptions;
import dev.cel.common.CelVarDecl;
import dev.cel.common.types.CelType;
import dev.cel.common.types.CelTypeProvider;
/** Interface for building an instance of CelChecker */
public interface CelCheckerBuilder {
/** Set the {@code CelOptions} used to enable fixes and features for this CEL instances. */
@CanIgnoreReturnValue
CelCheckerBuilder setOptions(CelOptions options);
/**
* Set the {@code container} name to use as the namespace for resolving CEL expression variables
* and functions.
*/
@CanIgnoreReturnValue
CelCheckerBuilder setContainer(String container);
/** Add variable and function {@code declarations} to the CEL environment. */
@CanIgnoreReturnValue
CelCheckerBuilder addDeclarations(Decl... declarations);
/** Add variable and function {@code declarations} to the CEL environment. */
@CanIgnoreReturnValue
CelCheckerBuilder addDeclarations(Iterable declarations);
/** Add function declaration {@code CelFunctionDecl} to the CEL environment. */
@CanIgnoreReturnValue
CelCheckerBuilder addFunctionDeclarations(CelFunctionDecl... celFunctionDecls);
/** Add function declaration {@code CelFunctionDecl} to the CEL environment. */
@CanIgnoreReturnValue
CelCheckerBuilder addFunctionDeclarations(Iterable celFunctionDecls);
/** Add variable declaration {@code CelVarDecl} to the CEL environment. */
@CanIgnoreReturnValue
CelCheckerBuilder addVarDeclarations(CelVarDecl... celVarDecls);
/** Add variable declaration {@code CelVarDecl} to the CEL environment. */
@CanIgnoreReturnValue
CelCheckerBuilder addVarDeclarations(Iterable celVarDecls);
/**
* Add one or more {@link ProtoTypeMask} values. The {@code ProtoTypeMask} values will be used to
* compute a set of {@code Decl} values using a protobuf message's fields as the names and types
* of the variables if {@link ProtoTypeMask#fieldsAreVariableDeclarations} is {@code true}.
*
* Note, this feature may not work with custom {@link TypeProvider} implementations out of the
* box, as it requires the implementation of {@link TypeProvider#lookupFieldNames} to return the
* set of all fields declared on the protobuf type.
*/
@CanIgnoreReturnValue
CelCheckerBuilder addProtoTypeMasks(ProtoTypeMask... typeMasks);
/**
* Add one or more {@link ProtoTypeMask} values. The {@code ProtoTypeMask} values will be used to
* compute a set of {@code Decl} values using a protobuf message's fields as the names and types
* of the variables if {@link ProtoTypeMask#fieldsAreVariableDeclarations} is {@code true}.
*
*
Note, this feature may not work with custom {@link TypeProvider} implementations out of the
* box, as it requires the implementation of {@link TypeProvider#lookupFieldNames} to return the
* set of all fields declared on the protobuf type.
*/
@CanIgnoreReturnValue
CelCheckerBuilder addProtoTypeMasks(Iterable typeMasks);
/** Set the expected {@code resultType} for the type-checked expression. */
@CanIgnoreReturnValue
CelCheckerBuilder setResultType(CelType resultType);
/**
* Set the expected {@code resultType} in proto format described in checked.proto for the
* type-checked expression.
*/
@CanIgnoreReturnValue
CelCheckerBuilder setProtoResultType(Type resultType);
/**
* Set the {@code typeProvider} for use with type-checking expressions.
*
* @deprecated Use {@link #setTypeProvider(CelTypeProvider)} instead.
*/
@CanIgnoreReturnValue
@Deprecated
CelCheckerBuilder setTypeProvider(TypeProvider celTypeProvider);
/** Set the {@code celTypeProvider} for use with type-checking expressions. */
@CanIgnoreReturnValue
CelCheckerBuilder setTypeProvider(CelTypeProvider celTypeProvider);
/**
* Add message {@link Descriptor}s to the use for type-checking and object creation at
* interpretation time.
*/
@CanIgnoreReturnValue
CelCheckerBuilder addMessageTypes(Descriptor... descriptors);
/**
* Add message {@link Descriptor}s to the use for type-checking and object creation at
* interpretation time.
*/
@CanIgnoreReturnValue
CelCheckerBuilder addMessageTypes(Iterable descriptors);
/**
* Add {@link FileDescriptor}s to the use for type-checking, and for object creation at
* interpretation time.
*/
@CanIgnoreReturnValue
CelCheckerBuilder addFileTypes(FileDescriptor... fileDescriptors);
/**
* Add {@link FileDescriptor}s to the use for type-checking, and for object creation at
* interpretation time.
*/
@CanIgnoreReturnValue
CelCheckerBuilder addFileTypes(Iterable fileDescriptors);
/**
* Add all of the {@link FileDescriptor}s in a {@code FileDescriptorSet} to the use for
* type-checking, and for object creation at interpretation time.
*/
@CanIgnoreReturnValue
CelCheckerBuilder addFileTypes(FileDescriptorSet fileDescriptorSet);
/** Enable or disable the standard CEL library functions and variables */
@CanIgnoreReturnValue
CelCheckerBuilder setStandardEnvironmentEnabled(boolean value);
/** Adds one or more libraries for parsing and type-checking. */
@CanIgnoreReturnValue
CelCheckerBuilder addLibraries(CelCheckerLibrary... libraries);
/** Adds a collection of libraries for parsing and type-checking. */
@CanIgnoreReturnValue
CelCheckerBuilder addLibraries(Iterable libraries);
/** Build a new instance of the {@code CelChecker}. */
@CheckReturnValue
CelChecker build();
}