org.mozilla.javascript.commonjs.module.ModuleScriptProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rhino-runtime Show documentation

Rhino JavaScript runtime jar, excludes tools & JSR-223 Script Engine wrapper.

The newest version!

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

package org.mozilla.javascript.commonjs.module;

import java.net.URI;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.Scriptable;

/**
 * Should be implemented by Rhino embeddings to allow the require() function to obtain {@link
 * ModuleScript} objects. We provide two default implementations, but you can of course roll your
 * own if they don't suit your needs.
 *
 * @author Attila Szegedi
 * @version $Id: ModuleScriptProvider.java,v 1.4 2011/04/07 20:26:11 hannes%helma.at Exp $
 */
public interface ModuleScriptProvider {
    /**
     * Returns a module script. It should attempt to load the module script if it is not already
     * available to it, or return an already loaded module script instance if it is available to it.
     *
     * @param cx current context. Can be used to compile module scripts.
     * @param moduleId the ID of the module. An implementation must only accept an absolute ID,
     *     starting with a term.
     * @param moduleUri the URI of the module. If this is not null, resolution of moduleId
     *      is bypassed and the script is directly loaded from moduleUri
     * @param baseUri the module path base URI from which moduleUri was derived.
     * @param paths the value of the require() function's "paths" attribute. If the require()
     *     function is sandboxed, it will be null, otherwise it will be a JavaScript Array object.
     *     It is up to the provider implementation whether and how it wants to honor the contents of
     *     the array.
     * @return a module script representing the compiled code of the module. Null should be returned
     *     if the script could not found.
     * @throws Exception if there was an unrecoverable problem obtaining the script
     * @throws IllegalArgumentException if the module ID is syntactically not a valid absolute
     *     module identifier.
     */
    public ModuleScript getModuleScript(
            Context cx, String moduleId, URI moduleUri, URI baseUri, Scriptable paths)
            throws Exception;
}