CachedScript.java

/*******************************************************************************
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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
 * <p/>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p/>
 * 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.apache.sling.scripting.api;

import javax.script.CompiledScript;

/**
 * The {@code CachedScript} provides an abstraction on top of {@link CompiledScript} such that compiled scripts can be cached for further
 * executions.
 */
public interface CachedScript {

    /**
     * Returns the path of the script which was compiled and cached.
     *
     * @return the script's path
     */
    String getScriptPath();

    /**
     * Returns the compiled script which can be used for further executions / evaluations.
     *
     * @return the compiled script
     */
    CompiledScript getCompiledScript();

}