Package org.mozilla.javascript.commonjs.module.provider

Class CachingModuleScriptProviderBase

java.lang.Object

org.mozilla.javascript.commonjs.module.provider.CachingModuleScriptProviderBase

All Implemented Interfaces:

java.io.Serializable, ModuleScriptProvider

Direct Known Subclasses:

SoftCachingModuleScriptProvider, StrongCachingModuleScriptProvider

public abstract class CachingModuleScriptProviderBase
extends java.lang.Object
implements ModuleScriptProvider, java.io.Serializable

Abstract base class that implements caching of loaded module scripts. It uses a ModuleSourceProvider to obtain the source text of the scripts. It supports a cache revalidation mechanism based on validator objects returned from the ModuleSourceProvider. Instances of this class and its subclasses are thread safe (and written to perform decently under concurrent access).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CachingModuleScriptProviderBase.CachedModuleScript	Instances of this class represent a loaded and cached module script.

Method Summary

Modifier and Type	Method	Description
ModuleScript	getModuleScript(Context cx, java.lang.String moduleId, java.net.URI moduleUri, java.net.URI baseUri, Scriptable paths)	Returns a module script.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getModuleScript

public ModuleScript getModuleScript(Context cx,
                                    java.lang.String moduleId,
                                    java.net.URI moduleUri,
                                    java.net.URI baseUri,
                                    Scriptable paths)
                             throws java.lang.Exception

Description copied from 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.

Specified by:

getModuleScript in interface ModuleScriptProvider

Parameters:

cx - current context. Can be used to compile module scripts.

moduleId - the ID of the module. An implementation must only accept an absolute ID, starting with a term.

moduleUri - the URI of the module. If this is not null, resolution of moduleId is bypassed and the script is directly loaded from moduleUri

baseUri - the module path base URI from which moduleUri was derived.

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.

Returns:

a module script representing the compiled code of the module. Null should be returned if the script could not found.

Throws:

java.lang.Exception - if there was an unrecoverable problem obtaining the script

java.lang.IllegalArgumentException - if the module ID is syntactically not a valid absolute module identifier.