net.citizensnpcs.api.scripting

Class ScriptCompiler

java.lang.Object

net.citizensnpcs.api.scripting.ScriptCompiler

public class ScriptCompiler
extends Object

Compiles files into ScriptFactorys. Intended for use as a separate thread - run(String, String) will block while waiting for new tasks to compile. Works with all installed system ScriptEngines. By default compatible with js via Nashorn/Rhino.

See Also:

ScriptEngineManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ScriptCompiler.CompileTaskBuilder

Constructor Summary

Constructors

Constructor and Description
ScriptCompiler(ClassLoader overrideClassLoader)

Method Summary

Modifier and Type	Method and Description
boolean	canCompile(File file)
ScriptCompiler.CompileTaskBuilder	compile(File file) Create a builder to compile the given files.
ScriptCompiler.CompileTaskBuilder	compile(String src, String identifier, String extension) Create a builder to compile the given source code.
void	interrupt() Cancel all running compile tasks.
void	registerGlobalContextProvider(ContextProvider provider) Registers a global ContextProvider, which will be invoked on all scripts created by this ScriptCompiler.
void	run(String code, String extension)
void	run(String code, String extension, Map<String,Object> vars) Run the given source code.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptCompiler

public ScriptCompiler(ClassLoader overrideClassLoader)

Method Detail

canCompile

public boolean canCompile(File file)

compile

public ScriptCompiler.CompileTaskBuilder compile(File file)

Create a builder to compile the given files.

Parameters:

file - The file to compile

Returns:

The ScriptCompiler.CompileTaskBuilder

compile

public ScriptCompiler.CompileTaskBuilder compile(String src,
                                                 String identifier,
                                                 String extension)

Create a builder to compile the given source code.

Parameters:

src - The source code to compile

identifier - A unique identifier of the source code

extension - The source code externsion

Returns:

The ScriptCompiler.CompileTaskBuilder

interrupt

public void interrupt()

Cancel all running compile tasks.

registerGlobalContextProvider

public void registerGlobalContextProvider(ContextProvider provider)

Registers a global ContextProvider, which will be invoked on all scripts created by this ScriptCompiler.

Parameters:

provider - The global provider

run

public void run(String code,
                String extension)
         throws ScriptException

Throws:

ScriptException

See Also:

run(String, String, Map)

run

public void run(String code,
                String extension,
                Map<String,Object> vars)
         throws ScriptException

Run the given source code.

Parameters:

code - the source code to compile/run

extension - the code extension e.g. js

vars - variables to pass to the script

Throws:

ScriptException