1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.jexl3.parser;
18
19 import org.apache.commons.jexl3.JexlException;
20 import org.apache.commons.jexl3.JexlFeatures;
21 import org.apache.commons.jexl3.JexlInfo;
22 import org.apache.commons.jexl3.internal.Scope;
23
24 /**
25 * The interface that produces a JEXL script AST from a source.
26 *
27 * @since 3.5.0
28 */
29 public interface JexlScriptParser {
30
31 /**
32 * Parses a script or expression.
33 *
34 * @param info information structure
35 * @param features the set of parsing features
36 * @param src the expression to parse
37 * @param scope the script frame
38 * @return the parsed tree
39 * @throws JexlException if any error occurred during parsing
40 */
41 ASTJexlScript parse(final JexlInfo info, final JexlFeatures features, final String src, final Scope scope);
42
43 /**
44 * Parses an embedded JXLT script or expression, an interpolation expression.
45 *
46 * @param info information structure
47 * @param features the set of parsing features
48 * @param src the expression to parse
49 * @param scope the script frame
50 * @return the parsed tree
51 * @throws JexlException if any error occurred during parsing
52 */
53 default ASTJexlScript jxltParse(final JexlInfo info, final JexlFeatures features, final String src, final Scope scope) {
54 return parse(info, features, src, scope);
55 }
56
57 }