Class NodejsRequiredSourceModule

java.lang.Object

com.ibm.wala.classLoader.FileModule

com.ibm.wala.classLoader.SourceFileModule

com.ibm.wala.cast.js.nodejs.NodejsRequiredSourceModule

All Implemented Interfaces:

Module, ModuleEntry, SourceModule

Direct Known Subclasses:

NodejsRequiredCoreModule

public class NodejsRequiredSourceModule
extends SourceFileModule

This class is intended to be used whenever a JavaScript module is dynamically required by JavaScript (CommonJS). The required file will be loaded and wrapped in a function call to simulate the real behavior of a CommonJS environment. The resulting function will be named GLOBAL_PREFIX + relative file-name. To retrieve the final function name, use getFunctioName().

Author:

Brian Pfretzschner <brian.pfretzschner@gmail.com>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NodejsRequiredSourceModule(String className, File f, SourceFileModule clonedFrom)

Method Summary

Modifier and Type	Method	Description
static String	convertFileToClassName(File rootDir, File file)	Generate a className based on the file name and path of the module file.
String	getClassName()
InputStream	getInputStream()
String	getName()
static NodejsRequiredSourceModule	make(File rootDir, File file)

Methods inherited from class SourceFileModule

getInputReader, getURL, isClassFile, isSourceFile, toString

Methods inherited from class FileModule

asModule, equals, getAbsolutePath, getContainer, getEntries, getFile, hashCode, isModuleFile

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Module

getEntries

Methods inherited from interface ModuleEntry

asModule, getContainer, isModuleFile

Constructor Details

NodejsRequiredSourceModule

protected NodejsRequiredSourceModule(String className,
 File f,
 SourceFileModule clonedFrom)
                              throws IOException

Parameters:

f - Must be a file located below folder workingDir.

Throws:

IOException

Method Details

getInputStream

public InputStream getInputStream()

Specified by:

getInputStream in interface ModuleEntry

Overrides:

getInputStream in class FileModule

Returns:

an InputStream which provides the contents of this logical file.

getClassName

public String getClassName()

Specified by:

getClassName in interface ModuleEntry

Overrides:

getClassName in class SourceFileModule

Returns:

the name of the class represented by this entry

getName

public String getName()

Specified by:

getName in interface ModuleEntry

Overrides:

getName in class FileModule

Returns:

a String that represents the name of the file described by this object

convertFileToClassName

public static String convertFileToClassName(File rootDir,
 File file)

Generate a className based on the file name and path of the module file. The path should be encoded in the className since the file name is not unique.

make

public static NodejsRequiredSourceModule make(File rootDir,
 File file)
                                       throws IOException

Throws:

IOException