io.purplejs.core.context

Interface ExecutionContext

public interface ExecutionContext

This object is available as a global javascript object (__ - double underscore).

Method Summary

Modifier and Type	Method and Description
void	disposer(Runnable runnable) Adds a new disposer.
Engine	getEngine() Returns the engine instance.
Environment	getEnvironment() Returns the script environment.
Object	getInstance(String type) Returns an instance of the specified component from the registry.
Object	getInstanceOrNull(String type) Returns an instance of the specified component from the registry.
ScriptLogger	getLogger() Returns the script logger.
Supplier<?>	getProvider(String type) Returns a provider of the specified component from the registry.
Registry	getRegistry() Returns the component registry.
ResourcePath	getResource() Returns the actual script running.
Object	newBean(String type) Constructs a new instance of the specified type.
void	registerMock(String path, Object value) Register a mock object to the specified path.
Object	require(String path) Require a new javascript file or json file relative to the current file.
ResourcePath	resolve(String path) Resolve a new file resource.
Object	toNativeObject(Object value) Converts a object to native javascript object.
ScriptValue	toScriptValue(Object value) Converts a value to a script value.

Method Detail

getEngine

Engine getEngine()

Returns the engine instance.

Returns:

engine instance.

getResource

ResourcePath getResource()

Returns the actual script running.

Returns:

script running.

getEnvironment

Environment getEnvironment()

Returns the script environment.

Returns:

script environment.

getLogger

ScriptLogger getLogger()

Returns the script logger.

Returns:

script logger.

getRegistry

Registry getRegistry()

Returns the component registry.

Returns:

the component registry.

require

Object require(String path)

Require a new javascript file or json file relative to the current file.

Parameters:

path - Absolute or relative path.

Returns:

exports for javascript or json.

resolve

ResourcePath resolve(String path)

Resolve a new file resource. The file can be relative or absolute.

Parameters:

path - Absolute or relative path.

Returns:

the resource path.

disposer

void disposer(Runnable runnable)

Adds a new disposer.

Parameters:

runnable - Disposer to add.

toScriptValue

ScriptValue toScriptValue(Object value)

Converts a value to a script value.

Parameters:

value - Value to convert.

Returns:

converted script value instance.

toNativeObject

Object toNativeObject(Object value)

Converts a object to native javascript object.

Parameters:

value - Value to convert.

Returns:

a native javascript object.

registerMock

void registerMock(String path,
                  Object value)

Register a mock object to the specified path.

Parameters:

path - Absolute path to the object.

value - Object to return from require.

getInstance

Object getInstance(String type)
            throws Exception

Returns an instance of the specified component from the registry.

Parameters:

type - Type of object (class-name).

Returns:

an instance of the component.

Throws:

Exception - if anything went wrong.

getInstanceOrNull

Object getInstanceOrNull(String type)
                  throws Exception

Returns an instance of the specified component from the registry.

Parameters:

type - Type of object (class-name).

Returns:

an instance of the component or null if not exists.

Throws:

Exception - if anything went wrong.

getProvider

Supplier<?> getProvider(String type)
                 throws Exception

Returns a provider of the specified component from the registry.

Parameters:

type - Type of object (class-name).

Returns:

a provider of the component.

Throws:

Exception - if anything went wrong.

newBean

Object newBean(String type)
        throws Exception

Constructs a new instance of the specified type.

Parameters:

type - Type of object (class-name).

Returns:

the new instance.

Throws:

Exception - if anything went wrong.