dev.cel.validator.CelValidator Maven / Gradle / Ivy

Go to download
// Copyright 2023 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.validator;

import dev.cel.common.CelAbstractSyntaxTree;
import dev.cel.common.CelValidationResult;

/** Public interface for validating an AST. */
public interface CelValidator {

  /**
   * Performs custom validation of the provided AST.
   *
   * This invokes all the AST validators present in this CelValidator instance via {@link
   * CelValidatorBuilder#addAstValidators} in their added order. Any exceptions thrown within the
   * AST validator will be propagated to the caller and will abort the validation process.
   *
   * The result of the validation is bundled inside {@link CelValidationResult}.
   *
   * @param ast A type-checked AST.
   */
  CelValidationResult validate(CelAbstractSyntaxTree ast);
}