org.ringojs.engine

Class RingoConfig

java.lang.Object

org.ringojs.engine.RingoConfig

public class RingoConfig
extends Object

This class describes the configuration for a RingoJS application or shell session.

Author:

hannes

Constructor Summary

Constructors

Constructor and Description
RingoConfig(Repository ringoHome) Create a new Ringo configuration and sets up its module search path.
RingoConfig(Repository ringoHome, Repository appHome, String[] userModules, String[] systemModules) Create a new Ringo configuration and sets up its module search path.
RingoConfig(Repository ringoHome, String[] userModules, String[] systemModules) Create a new Ringo configuration and sets up its module search path.

Method Summary

Modifier and Type	Method and Description
void	addModuleRepository(Repository repository) Add a repository to the module search path.
String[]	getArguments()
List<String>	getBootstrapScripts()
String	getCharset()
org.mozilla.javascript.ClassShutter	getClassShutter()
boolean	getDebug()
Class<org.mozilla.javascript.Scriptable>[]	getHostClasses() Get the host classes to be added to the Rhino engine.
int	getLanguageVersion() Get the desired JavaScript langauge version
String	getMainModule() Get the module name of the main resource of the configuration.
Resource	getMainResource() Get the main script resource resolved by calling setMainScript(String).
int	getOptLevel() Get the Rhino optimization level
List<Repository>	getRepositories() Get a list of repositoris from the given ringoHome and ringoPath settings using the ringo.home and ringo.path system properties as fallback.
Repository	getRepository(String path) Get a resource from our script repository
Resource	getResource(String path) Get a resource from our script repository
Resource	getResource(String path, ModuleLoader[] loaders) Get a resource from our script repository
List<Resource>	getResources(String path, boolean recursive) Get a list of all child resources for the given path relative to our script repository.
Repository	getRingoHome() Return the ringo install directory
boolean	getStrictVars()
org.mozilla.javascript.WrapFactory	getWrapFactory()
boolean	hasParentProtoProperties() Get the flag to enable __parent__ and __proto__ properties on JS objects
boolean	isPolicyEnabled()
boolean	isReloading()
boolean	isSealed()
boolean	isVerbose()
Repository	resolveRepository(String path, boolean system) Resolve a module repository path.
void	setArguments(String[] arguments)
void	setBootstrapScripts(List<String> bootstrapScripts)
void	setCharset(String charset)
void	setClassShutter(org.mozilla.javascript.ClassShutter classShutter)
void	setDebug(boolean debug)
void	setHostClasses(Class<org.mozilla.javascript.Scriptable>[] classes) Set the host classes to be added to the Rhino engine.
void	setMainScript(String scriptName) Set the main script for this configuration.
void	setOptLevel(int optlevel) Set the Rhino optimization level
void	setParentProtoProperties(boolean flag) Set the flag to enable __parent__ and __proto__ properties on JS objects
void	setPolicyEnabled(boolean hasPolicy)
void	setReloading(boolean reloading)
void	setSealed(boolean sealed)
void	setStrictVars(boolean strictVars)
void	setVerbose(boolean verbose)
void	setWrapFactory(org.mozilla.javascript.WrapFactory wrapFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

RingoConfig

public RingoConfig(Repository ringoHome)
            throws IOException

Create a new Ringo configuration and sets up its module search path.

Parameters:

ringoHome - the ringo installation directory

Throws:

FileNotFoundException - if a module path item does not exist

IOException

RingoConfig

public RingoConfig(Repository ringoHome,
                   String[] userModules,
                   String[] systemModules)
            throws IOException

Create a new Ringo configuration and sets up its module search path.

Parameters:

ringoHome - the ringo installation directory

userModules - the module search path as list of paths

systemModules - system module path to append to module path, or null

Throws:

FileNotFoundException - if a module path item does not exist

IOException

RingoConfig

public RingoConfig(Repository ringoHome,
                   Repository appHome,
                   String[] userModules,
                   String[] systemModules)
            throws IOException

Create a new Ringo configuration and sets up its module search path.

Parameters:

ringoHome - the ringo installation directory

appHome - the path to resolve application against, pass null for current working directory

userModules - the module search path as list of paths

systemModules - system module path to append to module path, or null

Throws:

FileNotFoundException - if a module path item does not exist

IOException

Method Detail

addModuleRepository

public void addModuleRepository(Repository repository)

Add a repository to the module search path.

Parameters:

repository - the repository to add.

resolveRepository

public Repository resolveRepository(String path,
                                    boolean system)
                             throws IOException

Resolve a module repository path.

Parameters:

path - the path

system - whether repository should be resolved as system repository

Returns:

a repository

Throws:

IOException - if an I/O error happened while resolving

setMainScript

public void setMainScript(String scriptName)
                   throws IOException

Set the main script for this configuration. If the scriptName argument is not null, we check whether the script is already contained in the ringo module path. If not, the script's parent repository is prepended to the module path. If scriptName is null, we prepend the current working directory to the module path.

Parameters:

scriptName - the name of the script, or null.

Throws:

FileNotFoundException - if the script repository does not exist

IOException

getMainResource

public Resource getMainResource()

Get the main script resource resolved by calling setMainScript(String).

Returns:

the main script resource, or null

getRingoHome

public Repository getRingoHome()

Return the ringo install directory

Returns:

the ringo home directory

getRepositories

public List<Repository> getRepositories()

Get a list of repositoris from the given ringoHome and ringoPath settings using the ringo.home and ringo.path system properties as fallback.

Returns:

a list of repositories matching the arguments and/or system properties

getMainModule

public String getMainModule()

Get the module name of the main resource of the configuration.

Returns:

the name of the main module

setHostClasses

public void setHostClasses(Class<org.mozilla.javascript.Scriptable>[] classes)

Set the host classes to be added to the Rhino engine.

Parameters:

classes - a list of Rhino host classes

getHostClasses

public Class<org.mozilla.javascript.Scriptable>[] getHostClasses()

Get the host classes to be added to the Rhino engine.

Returns:

a list of Rhino host classes

getOptLevel

public int getOptLevel()

Get the Rhino optimization level

Returns:

int value between -1 and 9

setOptLevel

public void setOptLevel(int optlevel)

Set the Rhino optimization level

Parameters:

optlevel - int value between -1 and 9

getDebug

public boolean getDebug()

setDebug

public void setDebug(boolean debug)

isVerbose

public boolean isVerbose()

setVerbose

public void setVerbose(boolean verbose)

getStrictVars

public boolean getStrictVars()

setStrictVars

public void setStrictVars(boolean strictVars)

getLanguageVersion

public int getLanguageVersion()

Get the desired JavaScript langauge version

Returns:

int value between 0 and 180

hasParentProtoProperties

public boolean hasParentProtoProperties()

Get the flag to enable __parent__ and __proto__ properties on JS objects

Returns:

true if __parent__ and __proto__ properties should be enabled

setParentProtoProperties

public void setParentProtoProperties(boolean flag)

Set the flag to enable __parent__ and __proto__ properties on JS objects

Parameters:

flag - true to enable __parent__ and __proto__ properties

getResource

public Resource getResource(String path)
                     throws IOException

Get a resource from our script repository

Parameters:

path - the resource path

Returns:

the resource

Throws:

IOException - an I/O error occurred

getResource

public Resource getResource(String path,
                            ModuleLoader[] loaders)
                     throws IOException

Get a resource from our script repository

Parameters:

path - the resource path

loaders - optional list of module loaders

Returns:

the resource

Throws:

IOException - an I/O error occurred

getRepository

public Repository getRepository(String path)
                         throws IOException

Get a resource from our script repository

Parameters:

path - the resource path

Returns:

the resource

Throws:

IOException - an I/O error occurred

getResources

public List<Resource> getResources(String path,
                                   boolean recursive)
                            throws IOException

Get a list of all child resources for the given path relative to our script repository.

Parameters:

path - the repository path

recursive - whether to include nested resources

Returns:

a list of all contained child resources

Throws:

IOException - an I/O error occurred

getCharset

public String getCharset()

setCharset

public void setCharset(String charset)

getClassShutter

public org.mozilla.javascript.ClassShutter getClassShutter()

setClassShutter

public void setClassShutter(org.mozilla.javascript.ClassShutter classShutter)

getWrapFactory

public org.mozilla.javascript.WrapFactory getWrapFactory()

setWrapFactory

public void setWrapFactory(org.mozilla.javascript.WrapFactory wrapFactory)

isSealed

public boolean isSealed()

setSealed

public void setSealed(boolean sealed)

isReloading

public boolean isReloading()

setReloading

public void setReloading(boolean reloading)

isPolicyEnabled

public boolean isPolicyEnabled()

setPolicyEnabled

public void setPolicyEnabled(boolean hasPolicy)

getBootstrapScripts

public List<String> getBootstrapScripts()

getArguments

public String[] getArguments()

setArguments

public void setArguments(String[] arguments)

setBootstrapScripts

public void setBootstrapScripts(List<String> bootstrapScripts)