io.purplejs.core

Interface EngineBuilder

public interface EngineBuilder

This is a builder of engines. It's the main entry point for developers wanted to use the engine directly.

Method Summary

Modifier and Type	Method and Description
Engine	build() Builds a new instance of engine.
EngineBuilder	classLoader(ClassLoader classLoader) Sets the classloader to use for creating new instances in the script engine.
EngineBuilder	devSourceDir(File dir) Sets where the script sources exists.
EngineBuilder	module(EngineModule module) Adds a new engine-module to do more configurations.
static EngineBuilder	newBuilder() Returns a new instance of this engine builder.
EngineBuilder	resourceLoader(ResourceLoader resourceLoader) Sets the resource-loader to use.
EngineBuilder	settings(Settings settings) Add settings to this engine.

Method Detail

devSourceDir

EngineBuilder devSourceDir(File dir)

Sets where the script sources exists. It's only used in the run-mode is set to DEV. This method can be called multiple times if it exists more than one source directory.

Parameters:

dir - directory for the sources.

Returns:

the instance of this builder.

classLoader

EngineBuilder classLoader(ClassLoader classLoader)

Sets the classloader to use for creating new instances in the script engine. If not set the, it's using the system application classloader.

Parameters:

classLoader - classloader to use.

Returns:

the instance of this builder.

resourceLoader

EngineBuilder resourceLoader(ResourceLoader resourceLoader)

Sets the resource-loader to use. If not set, it will be set to use a resource-loader that find resources in classpath based on the classloader.

Parameters:

resourceLoader - resource-loader to use.

Returns:

the instance of this builder.

module

EngineBuilder module(EngineModule module)

Adds a new engine-module to do more configurations.

Parameters:

module - engine-module to add.

Returns:

the instance of this builder.

settings

EngineBuilder settings(Settings settings)

Add settings to this engine.

Parameters:

settings - settings object to add.

Returns:

the instance of this builder.

build

Engine build()

Builds a new instance of engine. It will also run all initializes configured.

Returns:

a new engine instance.

newBuilder

static EngineBuilder newBuilder()

Returns a new instance of this engine builder.

Returns:

a new instance of this builder.