/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 *
 *    http://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 org.apache.fluss.spark.procedure

import org.apache.spark.sql.connector.catalog.TableCatalog

/**
 * Builder interface for creating Procedure instances.
 *
 * Procedure builders are used by the catalog to instantiate procedures with the necessary
 * dependencies.
 */
trait ProcedureBuilder {

  /**
   * Sets the table catalog that the procedure will use.
   *
   * @param tableCatalog
   *   the catalog instance
   * @return
   *   this builder for method chaining
   */
  def withTableCatalog(tableCatalog: TableCatalog): ProcedureBuilder

  /**
   * Builds and returns the procedure instance.
   *
   * @return
   *   the constructed Procedure
   */
  def build(): Procedure
}
