org.elasticsearch.script.ExecutableScript Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation

Elasticsearch subproject :core

There is a newer version: 8.14.1

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you 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 org.elasticsearch.script;

/**
 * An executable script, can't be used concurrently.
 */
public interface ExecutableScript {

    /**
     * Sets a runtime script parameter.
     * 
     * Note that this method may be slow, involving put() and get() calls
     * to a hashmap or similar.
     * @param name parameter name
     * @param value parameter value
     */
    void setNextVar(String name, Object value);

    /**
     * Executes the script.
     */
    Object run();

    /**
     * Unwraps a possible script value. For example, when passing vars and
     * expecting the returned value to be part of the vars. Javascript and
     * Python need this but other scripting engines just return the values
     * passed in.
     */
    default Object unwrap(Object value) {
        return value;
    }
}