freemarker.ext.script

Class FreeMarkerScriptEngineFactory

java.lang.Object

freemarker.ext.script.FreeMarkerScriptEngineFactory

All Implemented Interfaces:

javax.script.ScriptEngineFactory

public class FreeMarkerScriptEngineFactory
extends java.lang.Object
implements javax.script.ScriptEngineFactory

This is the implementation of JSR-223 (javax.script) script engine factory for FreeMarker. You might want to cast a generic script engine factory reference to this class if you want to invoke FreeMarkerScriptEngineFactory.setConfiguration(Configuration) to modify its configuration.

Field Summary

Fields

Modifier and Type	Field and Description
private freemarker.template.Configuration	config
private static java.util.List<java.lang.String>	extensions
private static java.util.List<java.lang.String>	mimeTypes
private static java.util.List<java.lang.String>	names
private static freemarker.cache.TemplateLoader	NOOP_TEMPLATE_LOADER

Constructor Summary

Constructors

Constructor and Description
FreeMarkerScriptEngineFactory()

Method Summary

Methods

Modifier and Type	Method and Description
private static java.lang.String	escapeString(java.lang.String s)
java.lang.String	getEngineName()
java.lang.String	getEngineVersion()
java.util.List<java.lang.String>	getExtensions()
java.lang.String	getLanguageName()
java.lang.String	getLanguageVersion()
java.lang.String	getMethodCallSyntax(java.lang.String object, java.lang.String method, java.lang.String... args)
java.util.List<java.lang.String>	getMimeTypes()
java.util.List<java.lang.String>	getNames()
java.lang.String	getOutputStatement(java.lang.String string)
java.lang.Object	getParameter(java.lang.String param)
java.lang.String	getProgram(java.lang.String... statements)
javax.script.ScriptEngine	getScriptEngine()
void	setConfiguration(freemarker.template.Configuration config) Sets a new FreeMarker configuration to use by all script engines created by this script engine factory.

Methods inherited from class java.lang.Object

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

Field Detail

config

private config

NOOP_TEMPLATE_LOADER

private static final NOOP_TEMPLATE_LOADER

extensions

private static final extensions

mimeTypes

private static final mimeTypes

names

private static final names

Constructor Detail

FreeMarkerScriptEngineFactory

public FreeMarkerScriptEngineFactory()

Method Detail

setConfiguration

public void setConfiguration(freemarker.template.Configuration config)
throws java.lang.IllegalArgumentException, java.lang.SecurityException

Sets a new FreeMarker configuration to use by all script engines created by this script engine factory. By default, the engine uses a private configuration instance with BeansWrapper and a no-op TemplateLoader.

Parameters:

config - the new FreeMarker configuration object

Throws:

java.lang.IllegalArgumentException - if config is null

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

getEngineName

public java.lang.String getEngineName()

Specified by:

getEngineName in interface javax.script.ScriptEngineFactory

getEngineVersion

public java.lang.String getEngineVersion()

Specified by:

getEngineVersion in interface javax.script.ScriptEngineFactory

getExtensions

public java.util.List<java.lang.String> getExtensions()

Specified by:

getExtensions in interface javax.script.ScriptEngineFactory

getLanguageName

public java.lang.String getLanguageName()

Specified by:

getLanguageName in interface javax.script.ScriptEngineFactory

getLanguageVersion

public java.lang.String getLanguageVersion()

Specified by:

getLanguageVersion in interface javax.script.ScriptEngineFactory

getMethodCallSyntax

public java.lang.String getMethodCallSyntax(java.lang.String object,
java.lang.String method,
java.lang.String... args)

Specified by:

getMethodCallSyntax in interface javax.script.ScriptEngineFactory

getMimeTypes

public java.util.List<java.lang.String> getMimeTypes()

Specified by:

getMimeTypes in interface javax.script.ScriptEngineFactory

getNames

public java.util.List<java.lang.String> getNames()

Specified by:

getNames in interface javax.script.ScriptEngineFactory

getOutputStatement

public java.lang.String getOutputStatement(java.lang.String string)

Specified by:

getOutputStatement in interface javax.script.ScriptEngineFactory

escapeString

private static java.lang.String escapeString(java.lang.String s)

getParameter

public java.lang.Object getParameter(java.lang.String param)

Specified by:

getParameter in interface javax.script.ScriptEngineFactory

getProgram

public java.lang.String getProgram(java.lang.String... statements)

Specified by:

getProgram in interface javax.script.ScriptEngineFactory

getScriptEngine

public javax.script.ScriptEngine getScriptEngine()

Specified by:

getScriptEngine in interface javax.script.ScriptEngineFactory