io.engineblock.scripting.Evaluator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eb-api Show documentation

The driver API for engineblock; Provides the interfaces needed to build drivers that can be loaded by engineblock core

There is a newer version: 2.12.65

/*
 *
 *    Copyright 2016 jshook
 *    Licensed 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 io.engineblock.scripting;

/**
 * 
 * An evaluator is a scripting helper that knows what its return type will be at runtime.
 * You can create an Evaluator from an environment and a desired return type, then reuse it.
 * Primitive types that can be mapped from the script to the return type should, including
 * 
 * 
 * Double -> Long
 * Double -> Integer
 * Double -> Float
 * Long -> Integer
 * 
 *
 * An evaluator is not threadsafe by default. If you need threadsafe evaluators with similar
 * semantics, wrap it in a ThreadLocal.
 *
 * @param  The return type that is needed by the caller
 */
public interface Evaluator {

    /**
     * Evaluate the provided script, returning the value that it yields
     *
     * @return An object of type T
     */
    T eval();

    /**
     * @param scriptText Nashorn compatible script text
     * @return this NahornEvaluator, for method chaining
     */
    NashornEvaluator script(String scriptText);

    /**
     * Set the variable environment of the evaluator
     *
     * @param varName the variable name to add to the environment
     * @param var     the object to bind to the varname
     * @return this NashornEvaluator, for method chaining
     */
    NashornEvaluator put(String varName, Object var);
}