java.lang.Object
- freemarker.core.Configurable
- - freemarker.core.Environment

All Implemented Interfaces:

Scope, TemplateHashModel, TemplateHashModelEx, TemplateModel
```
public final class Environment
extends Configurable
implements Scope
```
Object that represents the runtime environment during template processing. For every invocation of a Template.process() method, a new instance of this object is created, and then discarded when process() returns. This object stores the set of temporary variables created by the template, the value of settings set by the template, the reference to the data model root, etc. Everything that is needed to fulfill the template processing job.
Data models that need to access the Environment object that represents the template processing on the current thread can use the getCurrentEnvironment() method.
If you need to modify or read this object before or after the process call, use Template.createProcessingEnvironment(Object rootMap, Writer out, ObjectWrapper wrapper)

Nested Class Summary
- Nested classes/interfaces inherited from class freemarker.core.Configurable
  Configurable.UnknownSettingException
- Nested classes/interfaces inherited from interface freemarker.template.TemplateModel
  TemplateModel.InvalidExpressionModel, TemplateModel.JavaNull

Field Summary

Fields
Modifier and Type Field Description

static Writer NULL_WRITER
- Fields inherited from class freemarker.core.Configurable
  ARITHMETIC_ENGINE_KEY, BOOLEAN_FORMAT_KEY, DATE_FORMAT_KEY, DATETIME_FORMAT_KEY, LOCALE_KEY, NUMBER_FORMAT_KEY, OBJECT_WRAPPER_KEY, OUTPUT_ENCODING_KEY, STRICT_BEAN_MODELS, TEMPLATE_EXCEPTION_HANDLER_KEY, TIME_FORMAT_KEY, TIME_ZONE_KEY, URL_ESCAPING_CHARSET_KEY
- Fields inherited from interface freemarker.template.TemplateModel
  INVALID_EXPRESSION, JAVA_NULL, NOTHING

Constructor Summary

Constructors
Constructor Description

Environment(Template template, TemplateHashModel rootDataModel, Writer out)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Object`	`__getitem__(String key)`	A hook that Jython uses.
`void`	`__setitem__(String key, Object o)`	A hook that Jython uses.
`boolean`	`definesVariable(String name)`
`void`	`fallback()`
`String`	`formatDate(Date date, int type)`
`String`	`formatNumber(Number number)`
`TemplateModel`	`get(String name)`	This method returns a variable from the "global" namespace and falls back to the data model.
`NumberFormat`	`getCNumberFormat()`	Returns the `NumberFormat` used for the `c` built-in.
`Collator`	`getCollator()`
`Configuration`	`getConfiguration()`
`static Environment`	`getCurrentEnvironment()`	Retrieves the environment object associated with the current thread.
`MacroContext`	`getCurrentMacroContext()`
`TemplateNamespace`	`getCurrentNamespace()`	Returns the current name-space.
`String`	`getCurrentRecoveredErrorMessage()`
`Scope`	`getCurrentScope()`
`TemplateNodeModel`	`getCurrentVisitorNode()`
`TemplateHashModel`	`getDataModel()`	Returns the data model hash.
`DateFormat`	`getDateFormatObject(int dateType)`
`DateFormat`	`getDateFormatObject(int dateType, String pattern)`
`String`	`getDefaultNS()`
`Collection<String>`	`getDirectVariableNames()`	Returns the names of variables directly managed by this scope (i.e.
`String`	`getEffectiveURLEscapingCharset()`	Returns the name of the charset that should be used for URL encoding.
`List<freemarker.core.ast.TemplateElement>`	`getElementStack()`
`Scope`	`getEnclosingScope()`
`Environment`	`getEnvironment()`
`Scope`	`getGlobalNamespace()`	Returns a fictitious name-space that contains the globally visible variables that were created in the template, but not the variables of the data-model.
`Collection<String>`	`getKnownVariableNames()`	Returns a set of variable names that are known at the time of call.
`TemplateModel`	`getLastReturnValue()`
`MacroContext`	`getMacroContext(freemarker.core.ast.Macro macro)`
`TemplateNamespace`	`getMacroNamespace(freemarker.core.ast.Macro macro)`
`TemplateNamespace`	`getMainNamespace()`	Returns the main name-space.
`TemplateNamespace`	`getNamespace(String name)`	Returns the name-space for the name if exists, or null.
`String`	`getNamespaceForPrefix(String prefix)`
`static NumberFormat`	`getNewCNumberFormat()`
`NumberFormat`	`getNumberFormatObject(String pattern)`
`Writer`	`getOut()`
`String`	`getPrefixForNamespace(String nsURI)`
`Template`	`getTemplate()`	Retrieves the currently processed template.
`Template`	`getTemplateForImporting(String name)`	Gets a template for importing; used with `importLib(Template importedTemplate, String namespace, boolean global)`.
`Template`	`getTemplateForInclusion(String name, String encoding, boolean parse)`	Gets a template for inclusion; used with `include(Template includedTemplate, boolean freshNamespace)`.
`TemplateTransformModel`	`getTransform(freemarker.core.ast.Expression exp)`
`TemplateModel`	`getVariable(String name)`	Returns the variable that is visible in this context.
`TemplateNamespace`	`importLib(Template loadedTemplate, String namespace, boolean global)`	Emulates `import` directive.
`TemplateNamespace`	`importLib(String name, String namespace)`	Emulates `import` directive, except that `name` must be tempate root relative.
`void`	`include(Template includedTemplate, boolean freshNamespace)`	Processes a Template in the context of this `Environment`, including its output in the `Environment`'s Writer.
`void`	`include(String name, String encoding, boolean parse)`	Emulates `include` directive, except that `name` must be tempate root relative.
`boolean`	`isEmpty()`
`TemplateCollectionModel`	`keys()`
`void`	`outputInstructionStack(PrintWriter pw)`	Outputs the instruction stack.
`void`	`process()`	Processes the template to which this environment belongs.
`void`	`process(LoopContext ictxt)`	"visit" an IteratorBlock
`void`	`process(TemplateNodeModel node, TemplateSequenceModel namespaces)`
`void`	`put(String varname, TemplateModel value)`	Set a variable in this scope.
`TemplateModel`	`remove(String varname)`	Removes a variable in this scope.
`void`	`render(freemarker.core.ast.Macro macro, freemarker.core.ast.ArgsList args, freemarker.core.ast.ParameterList bodyParameters, freemarker.core.ast.TemplateElement nestedBlock)`	"visit" a macro.
`void`	`render(freemarker.core.ast.TemplateElement element)`	"Visit" the template element.
`void`	`render(freemarker.core.ast.TemplateElement attemptBlock, freemarker.core.ast.TemplateElement recoveryBlock, List<freemarker.core.parser.ParsingProblem> parsingProblems)`	Visit a block using buffering/recovery
`void`	`render(freemarker.core.ast.TemplateElement element, TemplateDirectiveModel directiveModel, Map<String,TemplateModel> args, List<String> bodyParameterNames)`
`void`	`render(freemarker.core.ast.TemplateElement element, TemplateTransformModel transform, Map<String,TemplateModel> args)`	"Visit" the template element, passing the output through a TemplateTransformModel
`void`	`render(MacroInvocationBodyContext bctxt)`
`void`	`render(TemplateNodeModel node, TemplateSequenceModel namespaces)`	"Visit" A TemplateNodeModel
`String`	`renderElementToString(freemarker.core.ast.TemplateElement te)`
`void`	`renderSecurely(freemarker.core.ast.TemplateElement element, CodeSource newCodeSource)`
`TemplateModel`	`resolveVariable(String name)`	Evaluates the variable of this name in this scope, falling back to the enclosing Scope if it is not defined in this one.
`<T> T`	`runInScope(Scope scope, TemplateRunnable<T> runnable)`
`void`	`setCurrentVisitorNode(TemplateNodeModel node)`	sets TemplateNodeModel as the current visitor node.
`void`	`setCurriedMacroNamespace(freemarker.core.ast.Macro curriedMacro, freemarker.core.ast.Macro baseMacro)`
`void`	`setDateFormat(String formatName)`	Sets the date format used to convert date models representing date-only dates to strings.
`void`	`setDateTimeFormat(String formatName)`	Sets the date format used to convert date models representing datetime dates to strings.
`void`	`setGlobalVariable(String name, TemplateModel model)`	Sets a variable that is visible globally.
`void`	`setLastReturnValue(TemplateModel lastReturnValue)`
`void`	`setLocale(Locale locale)`	Sets the locale to assume when searching for template files with no explicit requested locale.
`void`	`setLocalVariable(String name, TemplateModel model)`	Sets a local variable (one effective only during a macro invocation).
`void`	`setNumberFormat(String formatName)`	Sets the number format used to convert numbers to strings.
`void`	`setOut(Writer out)`
`void`	`setOutputEncoding(String outputEncoding)`	Sets the output encoding.
`void`	`setTemplateExceptionHandler(TemplateExceptionHandler templateExceptionHandler)`	Sets the exception handler used to handle template exceptions.
`void`	`setTimeFormat(String formatName)`	Sets the date format used to convert date models representing time-only values to strings.
`void`	`setTimeZone(TimeZone timeZone)`	Sets the time zone to use when formatting time values.
`void`	`setURLEscapingCharset(String urlEscapingCharset)`	Sets the URL escaping charset.
`void`	`setVariable(String name, TemplateModel model)`	Sets a variable in the current namespace.
`int`	`size()`
`void`	`unqualifiedSet(String name, TemplateModel model)`	Sets a variable in the most local scope available (corresponds to an unqualified #set instruction)
`TemplateCollectionModel`	`values()`
`void`	`visitMacroDef(freemarker.core.ast.Macro macro)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NULL_WRITER
```
public static final Writer NULL_WRITER
```
- Constructor Detail
  - Environment
```
public Environment(Template template,
                   TemplateHashModel rootDataModel,
                   Writer out)
            throws TemplateException
```
    Throws:
    
    TemplateException
- Method Detail
  - getCurrentEnvironment
```
public static Environment getCurrentEnvironment()
```
    Retrieves the environment object associated with the current thread. Data model implementations that need access to the environment can call this method to obtain the environment object that represents the template processing that is currently running on the current thread.
  - getTemplate
```
public Template getTemplate()
```
    Retrieves the currently processed template.
    
    Specified by:
    
    getTemplate in interface Scope
    
    Returns:
    
    the Template object associated with this Scope.
  - process
```
public void process()
             throws TemplateException,
                    IOException
```
    Processes the template to which this environment belongs.
    
    Throws:
    
    TemplateException
    
    IOException
  - renderSecurely
```
public void renderSecurely(freemarker.core.ast.TemplateElement element,
                           CodeSource newCodeSource)
                    throws TemplateException,
                           IOException
```
    Throws:
    
    TemplateException
    
    IOException
  - render
```
public void render(freemarker.core.ast.TemplateElement element)
            throws TemplateException,
                   IOException
```
    "Visit" the template element.
    
    Throws:
    
    TemplateException
    
    IOException
  - render
```
public void render(freemarker.core.ast.TemplateElement element,
                   TemplateDirectiveModel directiveModel,
                   Map<String,TemplateModel> args,
                   List<String> bodyParameterNames)
            throws TemplateException,
                   IOException
```
    Throws:
    
    TemplateException
    
    IOException
  - render
```
public void render(freemarker.core.ast.TemplateElement element,
                   TemplateTransformModel transform,
                   Map<String,TemplateModel> args)
            throws TemplateException,
                   IOException
```
    "Visit" the template element, passing the output through a TemplateTransformModel
    
    Parameters:
    
    element - the element to visit through a transform
    
    transform - the transform to pass the element output through
    
    args - optional arguments fed to the transform
    
    Throws:
    
    TemplateException
    
    IOException
  - render
```
public void render(freemarker.core.ast.TemplateElement attemptBlock,
                   freemarker.core.ast.TemplateElement recoveryBlock,
                   List<freemarker.core.parser.ParsingProblem> parsingProblems)
            throws TemplateException,
                   IOException
```
    Visit a block using buffering/recovery
    
    Throws:
    
    TemplateException
    
    IOException
  - getCurrentRecoveredErrorMessage
```
public String getCurrentRecoveredErrorMessage()
                                       throws TemplateException
```
    Throws:
    
    TemplateException
  - render
```
public void render(MacroInvocationBodyContext bctxt)
            throws TemplateException,
                   IOException
```
    Throws:
    
    TemplateException
    
    IOException
  - process
```
public void process(LoopContext ictxt)
             throws TemplateException,
                    IOException
```
    "visit" an IteratorBlock
    
    Throws:
    
    TemplateException
    
    IOException
  - render
```
public void render(TemplateNodeModel node,
                   TemplateSequenceModel namespaces)
            throws TemplateException,
                   IOException
```
    "Visit" A TemplateNodeModel
    
    Throws:
    
    TemplateException
    
    IOException
  - runInScope
```
public <T> T runInScope(Scope scope,
                        TemplateRunnable<T> runnable)
                 throws TemplateException,
                        IOException
```
    Throws:
    
    TemplateException
    
    IOException
  - fallback
```
public void fallback()
              throws TemplateException,
                     IOException
```
    Throws:
    
    TemplateException
    
    IOException
  - render
```
public void render(freemarker.core.ast.Macro macro,
                   freemarker.core.ast.ArgsList args,
                   freemarker.core.ast.ParameterList bodyParameters,
                   freemarker.core.ast.TemplateElement nestedBlock)
            throws TemplateException,
                   IOException
```
    "visit" a macro.
    
    Throws:
    
    TemplateException
    
    IOException
  - visitMacroDef
```
public void visitMacroDef(freemarker.core.ast.Macro macro)
                   throws TemplateException
```
    Throws:
    
    TemplateException
  - getMacroNamespace
```
public TemplateNamespace getMacroNamespace(freemarker.core.ast.Macro macro)
```
  - getMacroContext
```
public MacroContext getMacroContext(freemarker.core.ast.Macro macro)
```
  - setCurriedMacroNamespace
```
public void setCurriedMacroNamespace(freemarker.core.ast.Macro curriedMacro,
                                     freemarker.core.ast.Macro baseMacro)
```
  - process
```
public void process(TemplateNodeModel node,
                    TemplateSequenceModel namespaces)
             throws TemplateException,
                    IOException
```
    Throws:
    
    TemplateException
    
    IOException
  - getCurrentMacroContext
```
public MacroContext getCurrentMacroContext()
```
  - setTemplateExceptionHandler
```
public void setTemplateExceptionHandler(TemplateExceptionHandler templateExceptionHandler)
```
    Description copied from class: Configurable
    
    Sets the exception handler used to handle template exceptions.
    
    Overrides:
    
    setTemplateExceptionHandler in class Configurable
    
    Parameters:
    
    templateExceptionHandler - the template exception handler to use for handling TemplateExceptions. By default, TemplateExceptionHandler.HTML_DEBUG_HANDLER is used.
  - setLocale
```
public void setLocale(Locale locale)
```
    Description copied from class: Configurable
    
    Sets the locale to assume when searching for template files with no explicit requested locale.
    
    Overrides:
    
    setLocale in class Configurable
  - setTimeZone
```
public void setTimeZone(TimeZone timeZone)
```
    Description copied from class: Configurable
    
    Sets the time zone to use when formatting time values.
    
    Overrides:
    
    setTimeZone in class Configurable
  - setURLEscapingCharset
```
public void setURLEscapingCharset(String urlEscapingCharset)
```
    Description copied from class: Configurable
    
    Sets the URL escaping charset. Allows null, which means that the output encoding will be used for URL escaping.
    
    Overrides:
    
    setURLEscapingCharset in class Configurable
  - setOutputEncoding
```
public void setOutputEncoding(String outputEncoding)
```
    Description copied from class: Configurable
    
    Sets the output encoding. Allows null, which means that the output encoding is not known.
    
    Overrides:
    
    setOutputEncoding in class Configurable
  - getEffectiveURLEscapingCharset
```
public String getEffectiveURLEscapingCharset()
```
    Returns the name of the charset that should be used for URL encoding. This will be null if the information is not available. The function caches the return value, so it is quick to call it repeately.
  - getCollator
```
public Collator getCollator()
```
  - setOut
```
public void setOut(Writer out)
```
  - getOut
```
public Writer getOut()
```
  - formatNumber
```
public String formatNumber(Number number)
```
  - setNumberFormat
```
public void setNumberFormat(String formatName)
```
    Description copied from class: Configurable
    
    Sets the number format used to convert numbers to strings.
    
    Overrides:
    
    setNumberFormat in class Configurable
  - formatDate
```
public String formatDate(Date date,
                         int type)
                  throws TemplateModelException
```
    Throws:
    
    TemplateModelException
  - setTimeFormat
```
public void setTimeFormat(String formatName)
```
    Description copied from class: Configurable
    
    Sets the date format used to convert date models representing time-only values to strings.
    
    Overrides:
    
    setTimeFormat in class Configurable
  - setDateFormat
```
public void setDateFormat(String formatName)
```
    Description copied from class: Configurable
    
    Sets the date format used to convert date models representing date-only dates to strings.
    
    Overrides:
    
    setDateFormat in class Configurable
  - setDateTimeFormat
```
public void setDateTimeFormat(String formatName)
```
    Description copied from class: Configurable
    
    Sets the date format used to convert date models representing datetime dates to strings.
    
    Overrides:
    
    setDateTimeFormat in class Configurable
  - getConfiguration
```
public Configuration getConfiguration()
```
  - getLastReturnValue
```
public TemplateModel getLastReturnValue()
```
  - setLastReturnValue
```
public void setLastReturnValue(TemplateModel lastReturnValue)
```
  - getNumberFormatObject
```
public NumberFormat getNumberFormatObject(String pattern)
```
  - getDateFormatObject
```
public DateFormat getDateFormatObject(int dateType)
                               throws TemplateModelException
```
    Throws:
    
    TemplateModelException
  - getDateFormatObject
```
public DateFormat getDateFormatObject(int dateType,
                                      String pattern)
                               throws TemplateModelException
```
    Throws:
    
    TemplateModelException
  - getCNumberFormat
```
public NumberFormat getCNumberFormat()
```
    Returns the NumberFormat used for the c built-in. This is always US English "0.################", without grouping and without superfluous decimal separator.
  - getNewCNumberFormat
```
public static NumberFormat getNewCNumberFormat()
```
  - getTransform
```
public TemplateTransformModel getTransform(freemarker.core.ast.Expression exp)
                                    throws TemplateException
```
    Throws:
    
    TemplateException
  - resolveVariable
```
public TemplateModel resolveVariable(String name)
                              throws TemplateModelException
```
    Description copied from interface: Scope
    
    Evaluates the variable of this name in this scope, falling back to the enclosing Scope if it is not defined in this one.
    
    Specified by:
    
    resolveVariable in interface Scope
    
    Throws:
    
    TemplateModelException
  - getVariable
```
public TemplateModel getVariable(String name)
                          throws TemplateModelException
```
    Returns the variable that is visible in this context. This is the correspondent to an FTL top-level variable reading expression. That is, it tries to find the the variable in this order:
    
    An loop variable (if we're in a loop or user defined directive body) such as foo_has_next
    A local variable (if we're in a macro)
    A variable defined in the current namespace (say, via <#assign ...>)
    A variable defined globally (say, via <#global ....>)
    Variable in the data model:
    
    A variable in the root hash that was exposed to this rendering environment in the Template.process(...) call
    A shared variable set in the configuration via a call to Configuration.setSharedVariable(...)
    Throws:
    
    TemplateModelException
  - get
```
public TemplateModel get(String name)
                  throws TemplateModelException
```
    This method returns a variable from the "global" namespace and falls back to the data model.
    
    Specified by:
    
    get in interface TemplateHashModel
    
    Parameters:
    
    name - the name by which the TemplateModel is identified in the template.
    
    Returns:
    
    the TemplateModel referred to by the key, or null if not found.
    
    Throws:
    
    TemplateModelException
  - getDirectVariableNames
```
public Collection<String> getDirectVariableNames()
                                          throws TemplateModelException
```
    Description copied from interface: Scope
    
    Returns the names of variables directly managed by this scope (i.e. it does not traverse the chain of enclosing scopes, but limits itself to this scope only).
    
    Specified by:
    
    getDirectVariableNames in interface Scope
    
    Returns:
    
    a collection of known variable names for this scope, without enclosing scopes. The returned collection should be either immutable, or it should be disconnected from the scope, so any modifications to the collection don't affect the scope.
    
    Throws:
    
    TemplateModelException
  - setGlobalVariable
```
public void setGlobalVariable(String name,
                              TemplateModel model)
```
    Sets a variable that is visible globally. This is correspondent to FTL <#global name=model>.
  - setVariable
```
public void setVariable(String name,
                        TemplateModel model)
```
    Sets a variable in the current namespace. This is correspondent to FTL <#assign name=model>. This can be considered a convenient shorthand for: getCurrentNamespace().put(name, model)
  - setLocalVariable
```
public void setLocalVariable(String name,
                             TemplateModel model)
```
    Sets a local variable (one effective only during a macro invocation). This is correspondent to FTL <#local name=model>.
    
    Parameters:
    
    name - the identifier of the variable
    
    model - the value of the variable.
    
    Throws:
    
    IllegalStateException - if the environment is not executing a macro body.
  - unqualifiedSet
```
public void unqualifiedSet(String name,
                           TemplateModel model)
                    throws TemplateException
```
    Sets a variable in the most local scope available (corresponds to an unqualified #set instruction)
    
    Parameters:
    
    name - the identifier of the variable
    
    model - the value of the variable
    
    Throws:
    
    TemplateException
  - getCurrentScope
```
public Scope getCurrentScope()
```
  - getKnownVariableNames
```
public Collection<String> getKnownVariableNames()
                                         throws TemplateModelException
```
    Returns a set of variable names that are known at the time of call. This includes names of all shared variables in the Configuration, names of all global variables that were assigned during the template processing, names of all variables in the current name-space, names of all local variables and loop variables. If the passed root data model implements the TemplateHashModelEx interface, then all names it retrieves through a call to TemplateHashModelEx.keys() method are returned as well. The method returns a new Set object on each call that is completely disconnected from the Environment. That is, modifying the set will have no effect on the Environment object.
    
    Throws:
    
    TemplateModelException
  - outputInstructionStack
```
public void outputInstructionStack(PrintWriter pw)
```
    Outputs the instruction stack. Useful for debugging. TemplateExceptions incorporate this information in their stack traces.
    
    See Also:
    
    which exposes the actual element stack so that you can write your own custom stack trace or error message
  - getEnvironment
```
public Environment getEnvironment()
```
    Specified by:
    
    getEnvironment in interface Scope
    
    Overrides:
    
    getEnvironment in class Configurable
    
    Returns:
    
    the Environment object associated with this Scope.
  - getEnclosingScope
```
public Scope getEnclosingScope()
```
    Specified by:
    
    getEnclosingScope in interface Scope
    
    Returns:
    
    null This is the final fallback scope. It has no enclosing scope.
  - definesVariable
```
public boolean definesVariable(String name)
```
    Specified by:
    
    definesVariable in interface Scope
    
    Returns:
    
    whether the variable is defined in this specific scope. (It could be defined in a fallback scope and this method will return false.)
  - put
```
public void put(String varname,
                TemplateModel value)
```
    Description copied from interface: Scope
    
    Set a variable in this scope. This will typically only be used internally by the FreeMarker engine.
    
    Specified by:
    
    put in interface Scope
  - remove
```
public TemplateModel remove(String varname)
```
    Description copied from interface: Scope
    
    Removes a variable in this scope. This will typically only be used by FreeMarker engine internals
    
    Specified by:
    
    remove in interface Scope
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface TemplateHashModel
  - size
```
public int size()
         throws TemplateModelException
```
    Specified by:
    
    size in interface TemplateHashModelEx
    
    Returns:
    
    the number of key/value mappings in the hash.
    
    Throws:
    
    TemplateModelException
  - keys
```
public TemplateCollectionModel keys()
                             throws TemplateModelException
```
    Specified by:
    
    keys in interface TemplateHashModelEx
    
    Returns:
    
    a collection containing the keys in the hash. Every element of the returned collection must implement the TemplateScalarModel (as the keys of hashes are always strings).
    
    Throws:
    
    TemplateModelException
  - values
```
public TemplateCollectionModel values()
                               throws TemplateModelException
```
    Specified by:
    
    values in interface TemplateHashModelEx
    
    Returns:
    
    a collection containing the values in the hash.
    
    Throws:
    
    TemplateModelException
  - getNamespace
```
public TemplateNamespace getNamespace(String name)
```
    Returns the name-space for the name if exists, or null.
    
    Parameters:
    
    name - the template path that you have used with the import directive or importLib(String, String) call, in normalized form. That is, the path must be an absolute path, and it must not contain "/../" or "/./". The leading "/" is optional.
  - getMainNamespace
```
public TemplateNamespace getMainNamespace()
```
    Returns the main name-space. This is correspondent of FTL .main hash.
  - getCurrentNamespace
```
public TemplateNamespace getCurrentNamespace()
```
    Returns the current name-space. This is correspondent of FTL .namespace hash.
  - getGlobalNamespace
```
public Scope getGlobalNamespace()
```
    Returns a fictitious name-space that contains the globally visible variables that were created in the template, but not the variables of the data-model. There is no such thing in FTL; this strange method was added because of the JSP taglib support, since this imaginary name-space contains the page-scope attributes.
  - getDataModel
```
public TemplateHashModel getDataModel()
```
    Returns the data model hash. This is correspondent of FTL .datamodel hash. That is, it contains both the variables of the root hash passed to the Template.process(...), and the shared variables in the Configuration.
  - getElementStack
```
public List<freemarker.core.ast.TemplateElement> getElementStack()
```
  - getCurrentVisitorNode
```
public TemplateNodeModel getCurrentVisitorNode()
```
  - setCurrentVisitorNode
```
public void setCurrentVisitorNode(TemplateNodeModel node)
```
    sets TemplateNodeModel as the current visitor node. .current_node
  - include
```
public void include(String name,
                    String encoding,
                    boolean parse)
             throws IOException,
                    TemplateException
```
    Emulates include directive, except that name must be tempate root relative.
    It's the same as include(getTemplateForInclusion(name, encoding, parse)). But, you may want to separately call these two methods, so you can determine the source of exceptions more precisely, and thus achieve more intelligent error handling.
    
    Throws:
    
    IOException
    
    TemplateException
    
    See Also:
    
    getTemplateForInclusion(String name, String encoding, boolean parse), include(Template includedTemplate, boolean freshNamespace)
  - getTemplateForInclusion
```
public Template getTemplateForInclusion(String name,
                                        String encoding,
                                        boolean parse)
                                 throws IOException
```
    Gets a template for inclusion; used with include(Template includedTemplate, boolean freshNamespace). The advantage over simply using config.getTemplate(...) is that it chooses the default encoding as the include directive does.
    
    Parameters:
    
    name - the name of the template, relatively to the template root directory (not the to the directory of the currently executing template file!). (Note that you can use TemplateCache.getFullTemplatePath(freemarker.core.Environment, java.lang.String, java.lang.String) to convert paths to template root relative paths.)
    
    encoding - the encoding of the obtained template. If null, the encoding of the Template that is currently being processed in this Environment is used.
    
    parse - whether to process a parsed template or just include the unparsed template source.
    
    Throws:
    
    IOException
  - include
```
public void include(Template includedTemplate,
                    boolean freshNamespace)
             throws TemplateException,
                    IOException
```
    Processes a Template in the context of this Environment, including its output in the Environment's Writer.
    
    Parameters:
    
    includedTemplate - the template to process. Note that it does not need to be a template returned by getTemplateForInclusion(String name, String encoding, boolean parse).
    
    Throws:
    
    TemplateException
    
    IOException
  - importLib
```
public TemplateNamespace importLib(String name,
                                   String namespace)
                            throws IOException,
                                   TemplateException
```
    Emulates import directive, except that name must be tempate root relative.
    It's the same as importLib(getTemplateForImporting(name), namespace). But, you may want to separately call these two methods, so you can determine the source of exceptions more precisely, and thus achieve more intelligent error handling.
    
    Throws:
    
    IOException
    
    TemplateException
    
    See Also:
    
    getTemplateForImporting(String name), importLib(Template includedTemplate, String namespace, boolean global)
  - getTemplateForImporting
```
public Template getTemplateForImporting(String name)
                                 throws IOException
```
    Gets a template for importing; used with importLib(Template importedTemplate, String namespace, boolean global). The advantage over simply using config.getTemplate(...) is that it chooses the encoding as the import directive does.
    
    Parameters:
    
    name - the name of the template, relatively to the template root directory (not the to the directory of the currently executing template file!). (Note that you can use TemplateCache.getFullTemplatePath(freemarker.core.Environment, java.lang.String, java.lang.String) to convert paths to template root relative paths.)
    
    Throws:
    
    IOException
  - importLib
```
public TemplateNamespace importLib(Template loadedTemplate,
                                   String namespace,
                                   boolean global)
                            throws IOException,
                                   TemplateException
```
    Emulates import directive.
    
    Parameters:
    
    loadedTemplate - the template to import. Note that it does not need to be a template returned by getTemplateForImporting(String name).
    
    Throws:
    
    IOException
    
    TemplateException
  - renderElementToString
```
public String renderElementToString(freemarker.core.ast.TemplateElement te)
                             throws IOException,
                                    TemplateException
```
    Throws:
    
    IOException
    
    TemplateException
  - getNamespaceForPrefix
```
public String getNamespaceForPrefix(String prefix)
```
    Returns:
    
    the namespace URI registered for this prefix, or null. This is based on the mappings registered in the current namespace.
  - getPrefixForNamespace
```
public String getPrefixForNamespace(String nsURI)
```
  - getDefaultNS
```
public String getDefaultNS()
```
    Returns:
    
    the default node namespace for the current FTL namespace
  - __getitem__
```
public Object __getitem__(String key)
                   throws TemplateModelException
```
    A hook that Jython uses.
    
    Throws:
    
    TemplateModelException
  - __setitem__
```
public void __setitem__(String key,
                        Object o)
                 throws TemplateException
```
    A hook that Jython uses.
    
    Throws:
    
    TemplateException

Class Environment

Nested Class Summary

Nested classes/interfaces inherited from class freemarker.core.Configurable

Nested classes/interfaces inherited from interface freemarker.template.TemplateModel

Field Summary

Fields inherited from class freemarker.core.Configurable

Fields inherited from interface freemarker.template.TemplateModel

Constructor Summary

Method Summary

Methods inherited from class freemarker.core.Configurable

Methods inherited from class java.lang.Object

Field Detail

NULL_WRITER

Constructor Detail

Environment

Method Detail

getCurrentEnvironment

getTemplate

process

renderSecurely

render

render

render

render

getCurrentRecoveredErrorMessage

render

process

render

runInScope

fallback

render

visitMacroDef

getMacroNamespace

getMacroContext

setCurriedMacroNamespace

process

getCurrentMacroContext

setTemplateExceptionHandler

setLocale

setTimeZone

setURLEscapingCharset

setOutputEncoding

getEffectiveURLEscapingCharset

getCollator

setOut

getOut

formatNumber

setNumberFormat

formatDate

setTimeFormat

setDateFormat

setDateTimeFormat

getConfiguration

getLastReturnValue

setLastReturnValue

getNumberFormatObject

getDateFormatObject

getDateFormatObject

getCNumberFormat

getNewCNumberFormat

getTransform

resolveVariable

getVariable

get

getDirectVariableNames

setGlobalVariable

setVariable

setLocalVariable

unqualifiedSet

getCurrentScope

getKnownVariableNames

outputInstructionStack

getEnvironment

getEnclosingScope

definesVariable

put

remove

isEmpty

size

keys

getitem

setitem