freemarker.ext.script

Class FreeMarkerScriptEngine

java.lang.Object

javax.script.AbstractScriptEngine

freemarker.ext.script.FreeMarkerScriptEngine

All Implemented Interfaces:

javax.script.Compilable, javax.script.ScriptEngine

public class FreeMarkerScriptEngine
extends javax.script.AbstractScriptEngine
implements javax.script.Compilable

Implementation of a ScriptEngine for FreeMarker templates. Supports compilation by implementing the Compilable interface for efficient multiple execution of templates without reparsing. You might want to cast a generic script engine reference to this class if you want to invoke FreeMarkerScriptEngine.setConfiguration(Configuration) to modify its configuration.

Field Summary

Fields

Modifier and Type	Field and Description
private freemarker.template.Configuration	config
private FreeMarkerScriptEngineFactory	factory

Fields inherited from class javax.script.AbstractScriptEngine

context

Fields inherited from interface javax.script.ScriptEngine

ARGV, ENGINE, ENGINE_VERSION, FILENAME, LANGUAGE, LANGUAGE_VERSION, NAME

Constructor Summary

Constructors

Constructor and Description
FreeMarkerScriptEngine(FreeMarkerScriptEngineFactory factory, freemarker.template.Configuration config)

Method Summary

Methods

Modifier and Type	Method and Description
javax.script.CompiledScript	compile(java.io.Reader script)
javax.script.CompiledScript	compile(java.lang.String script)
javax.script.Bindings	createBindings()
java.lang.Object	eval(java.io.Reader script, javax.script.ScriptContext context)
java.lang.Object	eval(java.lang.String script, javax.script.ScriptContext context)
javax.script.ScriptEngineFactory	getFactory()
private void	checkSetConfiguration()
void	setConfiguration(freemarker.template.Configuration config) Sets a new FreeMarker configuration to use by all templates created by this script engine factory.

Methods inherited from class javax.script.AbstractScriptEngine

eval, eval, eval, eval, get, getBindings, getContext, getScriptContext, put, setBindings, setContext

Methods inherited from class java.lang.Object

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

Field Detail

factory

private final factory

config

private config

Constructor Detail

FreeMarkerScriptEngine

FreeMarkerScriptEngine(FreeMarkerScriptEngineFactory factory,
freemarker.template.Configuration config)

Method Detail

setConfiguration

public void setConfiguration(freemarker.template.Configuration config)

Sets a new FreeMarker configuration to use by all templates created by this script engine factory. By default it inherits the configuration of its factory at the time this engine instance was created (if the configuration of the factory is later changed, it doesn't affect this engine). Compiled scripts inherit the configuration of the engine at the time of invocation of the compile() method. If a security manager is set in the JVM, and the invoking code doesn't posess the "freeMarker.script.setEngineConfiguration" runtime permission, a security exception is thrown. Note that you can further override this Configuration by binding an instance of Configuration or Properties into the engine's Bindings under the name FreeMarkerScriptConstants.CONFIGURATION, but that is also subject to the same security check and if there are not sufficient privileges, an eval() or compile() call will also throw a SecurityException.

Parameters:

config - the new FreeMarker configuration object

Throws:

java.lang.IllegalArgumentException - if config is null

java.lang.SecurityException - if a security manager is set in the JVM, and the invoking code doesn't posess the "freeMarker.script.setEngineConfiguration" runtime permission.

checkSetConfiguration

private void checkSetConfiguration()

createBindings

public javax.script.Bindings createBindings()

Specified by:

createBindings in interface javax.script.ScriptEngine

eval

public java.lang.Object eval(java.lang.String script,
javax.script.ScriptContext context)
throws javax.script.ScriptException

Specified by:

eval in interface javax.script.ScriptEngine

Throws:

javax.script.ScriptException

eval

public java.lang.Object eval(java.io.Reader script,
javax.script.ScriptContext context)
throws javax.script.ScriptException

Specified by:

eval in interface javax.script.ScriptEngine

Throws:

javax.script.ScriptException

getFactory

public javax.script.ScriptEngineFactory getFactory()

Specified by:

getFactory in interface javax.script.ScriptEngine

compile

public javax.script.CompiledScript compile(java.lang.String script)
throws javax.script.ScriptException

Specified by:

compile in interface javax.script.Compilable

Throws:

javax.script.ScriptException

compile

public javax.script.CompiledScript compile(java.io.Reader script)
throws javax.script.ScriptException

Specified by:

compile in interface javax.script.Compilable

Throws:

javax.script.ScriptException