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 * http://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.scxml2;
18
19 import org.apache.commons.scxml2.model.SCXML;
20
21 /**
22 * An EvaluatorProvider provides an {@link Evaluator} instance for a specific SCXML datamodel type.
23 */
24 public interface EvaluatorProvider {
25
26 /**
27 * @return The SCXML datamodel type this provider supports
28 */
29 String getSupportedDatamodel();
30
31 /**
32 * @return a default or generic {@link Evaluator} supporting the {@link #getSupportedDatamodel()}
33 */
34 Evaluator getEvaluator();
35
36 /**
37 * Factory method to return a dedicated and optimized {@link Evaluator} instance for a specific SCXML document.
38 * <p>
39 * As the returned Evaluator <em>might</em> be optimized and dedicated for the SCXML document instance, the
40 * Evaluator may not be shareable and reusable for other SCXML documents.
41 * </p>
42 * @param document the SCXML document
43 * @return a new and not sharable Evaluator instance
44 */
45 Evaluator getEvaluator(SCXML document);
46 }