001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.scxml2;
018
019import org.apache.commons.scxml2.model.SCXML;
020
021/**
022 * An EvaluatorProvider provides an {@link Evaluator} instance for a specific SCXML datamodel type.
023 */
024public interface EvaluatorProvider {
025
026    /**
027     * @return The SCXML datamodel type this provider supports
028     */
029    String getSupportedDatamodel();
030
031    /**
032     * @return a default or generic {@link Evaluator} supporting the {@link #getSupportedDatamodel()}
033     */
034    Evaluator getEvaluator();
035
036    /**
037     * Factory method to return a dedicated and optimized {@link Evaluator} instance for a specific SCXML document.
038     * <p>
039     * As the returned Evaluator <em>might</em> be optimized and dedicated for the SCXML document instance, the
040     * Evaluator may not be shareable and reusable for other SCXML documents.
041     * </p>
042     * @param document the SCXML document
043     * @return a new and not sharable Evaluator instance
044     */
045    Evaluator getEvaluator(SCXML document);
046}