io.purplejs.core

Interface EngineBinder

public interface EngineBinder

This class is used to bind configuration values to the engine. It is used by the EngineModule.

Method Summary

Modifier and Type	Method and Description
EngineBinder	disposer(Consumer<Engine> disposer) Binds a disposer that is executed when the engine is disposed or if the script cache is expired.
EngineBinder	globalVariable(String name, Object value) Adds a global variable to the script engine.
EngineBinder	initializer(Consumer<Engine> initializer) Binds an initializer that is executed when the engine is created.
<T> EngineBinder	instance(Class<T> type, T instance) Binds an instance to a type.
<T> EngineBinder	provider(Class<T> type, Supplier<T> supplier) Binds a provider of a type.

Method Detail

instance

<T> EngineBinder instance(Class<T> type,
                          T instance)

Binds an instance to a type.

Type Parameters:

T - type of instance.

Parameters:

type - type to bind.

instance - instance of the type.

Returns:

the instance of this binder.

provider

<T> EngineBinder provider(Class<T> type,
                          Supplier<T> supplier)

Binds a provider of a type. Can be used for non-singleton services or values.

Type Parameters:

T - type of instance.

Parameters:

type - type to bind.

supplier - the supplier (or factory) to create an instance of type.

Returns:

the instance of this binder.

globalVariable

EngineBinder globalVariable(String name,
                            Object value)

Adds a global variable to the script engine.

Parameters:

name - name of variable.

value - variable instance.

Returns:

the instance of this binder.

initializer

EngineBinder initializer(Consumer<Engine> initializer)

Binds an initializer that is executed when the engine is created.

Parameters:

initializer - initializer to bind.

Returns:

the instance of this binder.

disposer

EngineBinder disposer(Consumer<Engine> disposer)

Binds a disposer that is executed when the engine is disposed or if the script cache is expired.

Parameters:

disposer - disposer to bind.

Returns:

the instance of this binder.