1 /*
2 * Copyright 2012-2025 CodeLibs Project and the Others.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13 * either express or implied. See the License for the specific language
14 * governing permissions and limitations under the License.
15 */
16 package org.codelibs.fess.script;
17
18 import java.util.Map;
19
20 /**
21 * Interface for script engines that can evaluate templates with parameters.
22 * This interface provides a contract for different script engine implementations
23 * to process template strings with parameter substitution.
24 */
25 public interface ScriptEngine {
26
27 /**
28 * Evaluates a template string with the provided parameter map.
29 * The template is processed using the script engine's templating mechanism,
30 * with parameters from the paramMap substituted into the template.
31 *
32 * @param template the template string to evaluate
33 * @param paramMap the map of parameters to substitute into the template
34 * @return the result of evaluating the template, or null if evaluation fails
35 */
36 Object evaluate(final String template, final Map<String, Object> paramMap);
37 }