freemarker.ext.script

Class FreeMarkerScriptConstants

java.lang.Object

freemarker.ext.script.FreeMarkerScriptConstants

public class FreeMarkerScriptConstants
extends java.lang.Object

Various variable names that you can use in various bindings to customize the operation of the scripts.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIGURATION If you bind an instance of Configuration under this name in your script engine, it will be used when evaluting a script, compiling a script, and evaluating a script compiled from that engine.
static java.lang.String	STRING_OUTPUT If you bind an instance of Boolean.TRUE under this name in your script context, the eval() will return the output of the template as a string.

Constructor Summary

Constructors

Constructor and Description
FreeMarkerScriptConstants()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

STRING_OUTPUT

public static final STRING_OUTPUT

If you bind an instance of Boolean.TRUE under this name in your script context, the eval() will return the output of the template as a string. When this value is not present (or it doesn't equal Boolean.TRUE), eval() calls return null, and the template output goes to ScriptContext.getWriter().

See Also:

Constant Field Values

CONFIGURATION

public static final CONFIGURATION

If you bind an instance of Configuration under this name in your script engine, it will be used when evaluting a script, compiling a script, and evaluating a script compiled from that engine. However, if there is a security manager in the JVM and the invoking code does not posess the "freeMarker.script.setEngineConfiguration" runtime permission, the attempt to evaluate/compile a script will throw a SecurityException. Instead of a Configuration, you can also bind an instance of Properties. In this case, a new Configuration object will be constructed on each evaluate/compile operation and initialized from the Properties object. This is however not really recommended, as it creates a new Configuration for each template - it is also subject to the security check, of course.

See Also:

Constant Field Values

Constructor Detail

FreeMarkerScriptConstants

public FreeMarkerScriptConstants()