udf-api/src/main/java/org/apache/iotdb/udf/api/UDF.java

/*
 * 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.iotdb.udf.api;

import org.apache.iotdb.udf.api.customizer.config.UDTFConfigurations;
import org.apache.iotdb.udf.api.customizer.parameter.UDFParameterValidator;
import org.apache.iotdb.udf.api.customizer.parameter.UDFParameters;

public interface UDF {

  /**
   * This method is mainly used to validate {@link UDFParameters} and it is executed before {@link
   * UDTF#beforeStart(UDFParameters, UDTFConfigurations)} is called.
   *
   * @param validator the validator used to validate {@link UDFParameters}
   * @throws Exception if any parameter is not valid
   */
  @SuppressWarnings("squid:S112")
  default void validate(UDFParameterValidator validator) throws Exception {}

  /** This method is mainly used to release the resources used in the UDF. */
  default void beforeDestroy() {}
}