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 aModuleSourceProviderto obtain the source text of the scripts. It supports a cache revalidation mechanism based on validator objects returned from theModuleSourceProvider. Instances of this class and its subclasses are thread safe (and written to perform decently under concurrent access).- See Also:
- Serialized Form
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classCachingModuleScriptProviderBase.CachedModuleScriptInstances of this class represent a loaded and cached module script.
 - 
Constructor SummaryConstructors Modifier Constructor Description protectedCachingModuleScriptProviderBase(ModuleSourceProvider moduleSourceProvider)Creates a new module script provider with the specified source.
 - 
Method SummaryAll Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected static intgetConcurrencyLevel()Returns the internal concurrency level utilized by caches in this JVM.protected abstract CachingModuleScriptProviderBase.CachedModuleScriptgetLoadedModule(java.lang.String moduleId)Retrieves an already loaded moduleScript stored usingputLoadedModule(String, ModuleScript, Object).ModuleScriptgetModuleScript(Context cx, java.lang.String moduleId, java.net.URI moduleUri, java.net.URI baseUri, Scriptable paths)Returns a module script.protected abstract voidputLoadedModule(java.lang.String moduleId, ModuleScript moduleScript, java.lang.Object validator)Store a loaded module script for later retrieval usinggetLoadedModule(String).
 
- 
- 
- 
Constructor Detail- 
CachingModuleScriptProviderBaseprotected CachingModuleScriptProviderBase(ModuleSourceProvider moduleSourceProvider) Creates a new module script provider with the specified source.- Parameters:
- moduleSourceProvider- provider for modules' source code
 
 
- 
 - 
Method Detail- 
getModuleScriptpublic 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:ModuleScriptProviderReturns 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:
- getModuleScriptin 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- moduleIdis bypassed and the script is directly loaded from- moduleUri
- baseUri- the module path base URI from which- moduleUriwas 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.
 
 - 
putLoadedModuleprotected abstract void putLoadedModule(java.lang.String moduleId, ModuleScript moduleScript, java.lang.Object validator)Store a loaded module script for later retrieval usinggetLoadedModule(String).- Parameters:
- moduleId- the ID of the module
- moduleScript- the module script
- validator- the validator for the module's source text entity
 
 - 
getLoadedModuleprotected abstract CachingModuleScriptProviderBase.CachedModuleScript getLoadedModule(java.lang.String moduleId) Retrieves an already loaded moduleScript stored usingputLoadedModule(String, ModuleScript, Object).- Parameters:
- moduleId- the ID of the module
- Returns:
- a cached module script, or null if the module is not loaded.
 
 - 
getConcurrencyLevelprotected static int getConcurrencyLevel() Returns the internal concurrency level utilized by caches in this JVM.- Returns:
- the internal concurrency level utilized by caches in this JVM.
 
 
- 
 
-