Uses of Class
freemarker.core.Environment

Packages that use Environment

Package	Description
freemarker.cache	Template loading and caching.
freemarker.core	The seldom used or advanced parts of the fundamental FreeMarker API, compared to freemarker.template.
freemarker.ext.servlet	Servlet for legacy "Model 2" frameworks that allows using FreeMarker templates instead of JSP as the MVC View (see in the Manual).
freemarker.template	The fundamental, most commonly used API-s of FreeMarker; start with Configuration (see also the Getting Started in the Manual.)
freemarker.template.utility	Various classes used by core FreeMarker code but might be useful outside of it too.

Uses of Environment in freemarker.cache

Methods in freemarker.cache with parameters of type Environment

Modifier and Type	Method and Description
static java.lang.String	TemplateCache.getFullTemplatePath(Environment env, java.lang.String baseName, java.lang.String targetName) Deprecated. Use toFullTemplateName(String, String) instead, as that can throw MalformedTemplateNameException, and is on a more logical place anyway.

Uses of Environment in freemarker.core

Methods in freemarker.core that return Environment

Modifier and Type	Method and Description
static Environment	Environment.getCurrentEnvironment() Retrieves the environment object associated with the current thread, or null if there's no template processing going on in this thread.
protected Environment	Configurable.getEnvironment()

Methods in freemarker.core with parameters of type Environment

Modifier and Type	Method and Description
protected void	Configurable.doAutoImportsAndIncludes(Environment env) Executes the auto-imports and auto-includes for the main template of this environment.
java.lang.Object	CustomAttribute.get(Environment env) Gets the attribute from the appropriate scope that's accessible through the specified Environment.
abstract TemplateDateFormat	TemplateDateFormatFactory.get(java.lang.String params, int dateType, java.util.Locale locale, java.util.TimeZone timeZone, boolean zonelessInput, Environment env) Returns a formatter for the given parameters.
TemplateDateFormat	AliasTemplateDateFormatFactory.get(java.lang.String params, int dateType, java.util.Locale locale, java.util.TimeZone timeZone, boolean zonelessInput, Environment env)
abstract TemplateNumberFormat	TemplateNumberFormatFactory.get(java.lang.String params, java.util.Locale locale, Environment env) Returns a formatter for the given parameters.
TemplateNumberFormat	AliasTemplateNumberFormatFactory.get(java.lang.String params, java.util.Locale locale, Environment env)
java.lang.Class	TemplateClassResolver.resolve(java.lang.String className, Environment env, Template template) Gets a Class based on the class name.
java.lang.Class	OptInTemplateClassResolver.resolve(java.lang.String className, Environment env, Template template)
void	CustomAttribute.set(java.lang.Object value, Environment env) Sets the attribute inside the appropriate scope that's accessible through the specified Environment.
abstract TemplateScalarModel	TruncateBuiltinAlgorithm.truncate(java.lang.String s, int maxLength, TemplateScalarModel terminator, java.lang.Integer terminatorLength, Environment env) Corresponds to ?truncate(...) in templates.
TemplateScalarModel	DefaultTruncateBuiltinAlgorithm.truncate(java.lang.String s, int maxLength, TemplateScalarModel terminator, java.lang.Integer terminatorLength, Environment env)
abstract TemplateScalarModel	TruncateBuiltinAlgorithm.truncateC(java.lang.String s, int maxLength, TemplateScalarModel terminator, java.lang.Integer terminatorLength, Environment env) Corresponds to ?truncate_c_m(...) in templates.
TemplateScalarModel	DefaultTruncateBuiltinAlgorithm.truncateC(java.lang.String s, int maxLength, TemplateScalarModel terminator, java.lang.Integer terminatorLength, Environment env)
abstract TemplateModel	TruncateBuiltinAlgorithm.truncateCM(java.lang.String s, int maxLength, TemplateModel terminator, java.lang.Integer terminatorLength, Environment env) Corresponds to ?truncate_c_m(...) in templates.
TemplateModel	DefaultTruncateBuiltinAlgorithm.truncateCM(java.lang.String s, int maxLength, TemplateModel terminator, java.lang.Integer terminatorLength, Environment env)
abstract TemplateModel	TruncateBuiltinAlgorithm.truncateM(java.lang.String s, int maxLength, TemplateModel terminator, java.lang.Integer terminatorLength, Environment env) Corresponds to ?truncate_m(...) in templates.
TemplateModel	DefaultTruncateBuiltinAlgorithm.truncateM(java.lang.String s, int maxLength, TemplateModel terminator, java.lang.Integer terminatorLength, Environment env)
abstract TemplateScalarModel	TruncateBuiltinAlgorithm.truncateW(java.lang.String s, int maxLength, TemplateScalarModel terminator, java.lang.Integer terminatorLength, Environment env) Corresponds to ?truncate_w(...) in templates.
TemplateScalarModel	DefaultTruncateBuiltinAlgorithm.truncateW(java.lang.String s, int maxLength, TemplateScalarModel terminator, java.lang.Integer terminatorLength, Environment env)
abstract TemplateModel	TruncateBuiltinAlgorithm.truncateWM(java.lang.String s, int maxLength, TemplateModel terminator, java.lang.Integer terminatorLength, Environment env) Corresponds to ?truncate_w_m(...) in templates.
TemplateModel	DefaultTruncateBuiltinAlgorithm.truncateWM(java.lang.String s, int maxLength, TemplateModel terminator, java.lang.Integer terminatorLength, Environment env)

Constructors in freemarker.core with parameters of type Environment

Constructor and Description
InvalidReferenceException(Environment env) Creates and invalid reference exception that contains no information about what was missing or null.
InvalidReferenceException(java.lang.String description, Environment env) Creates and invalid reference exception that contains no programmatically extractable information about the blamed expression.
NonBooleanException(Environment env)
NonBooleanException(java.lang.String description, Environment env)
NonDateException(Environment env)
NonDateException(java.lang.String description, Environment env)
NonExtendedHashException(Environment env)
NonExtendedHashException(java.lang.String description, Environment env)
NonExtendedNodeException(Environment env)
NonExtendedNodeException(java.lang.String description, Environment env)
NonHashException(Environment env)
NonHashException(java.lang.String description, Environment env)
NonMarkupOutputException(Environment env)
NonMarkupOutputException(java.lang.String description, Environment env)
NonMethodException(Environment env)
NonMethodException(java.lang.String description, Environment env)
NonNodeException(Environment env)
NonNodeException(java.lang.String description, Environment env)
NonNumericalException(Environment env)
NonNumericalException(java.lang.String description, Environment env)
NonSequenceException(Environment env)
NonSequenceException(java.lang.String description, Environment env)
NonSequenceOrCollectionException(Environment env)
NonSequenceOrCollectionException(java.lang.String description, Environment env)
NonStringException(Environment env)
NonStringException(java.lang.String description, Environment env)
NonStringOrTemplateOutputException(Environment env)
NonStringOrTemplateOutputException(java.lang.String description, Environment env)
UnexpectedTypeException(Environment env, java.lang.String description)

Uses of Environment in freemarker.ext.servlet

Methods in freemarker.ext.servlet with parameters of type Environment

Modifier and Type	Method and Description
void	IncludePage.execute(Environment env, java.util.Map params, TemplateModel[] loopVars, TemplateDirectiveBody body)
protected void	FreemarkerServlet.processEnvironment(Environment env, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This is the method that actually executes the template.

Uses of Environment in freemarker.template

Methods in freemarker.template that return Environment

Modifier and Type	Method and Description
Environment	Template.createProcessingEnvironment(java.lang.Object dataModel, java.io.Writer out) Same as createProcessingEnvironment(dataModel, out, null).
Environment	Template.createProcessingEnvironment(java.lang.Object dataModel, java.io.Writer out, ObjectWrapper wrapper) Creates a Environment object, using this template, the data-model provided as parameter.
Environment	TemplateException.getEnvironment()

Methods in freemarker.template with parameters of type Environment

Modifier and Type	Method and Description
protected void	Configuration.doAutoImportsAndIncludes(Environment env)
void	TemplateDirectiveModel.execute(Environment env, java.util.Map params, TemplateModel[] loopVars, TemplateDirectiveBody body) Executes this user-defined directive; called by FreeMarker when the user-defined directive is called in the template.
void	TemplateExceptionHandler.handleTemplateException(TemplateException te, Environment env, java.io.Writer out) Method called after a TemplateException was raised inside a template.
void	AttemptExceptionReporter.report(TemplateException te, Environment env) Called to log or otherwise report the error that has occurred inside an #attempt block.

Constructors in freemarker.template with parameters of type Environment

Constructor and Description
TemplateException(Environment env) Constructs a TemplateException with no specified detail message or underlying cause.
TemplateException(java.lang.Exception cause, Environment env) The same as TemplateException.TemplateException(Throwable, Environment); it's exists only for binary backward-compatibility.
TemplateException(java.lang.String description, Environment env) Constructs a TemplateException with the given detail message, but no underlying cause exception.
TemplateException(java.lang.String description, java.lang.Exception cause, Environment env) The same as TemplateException.TemplateException(String, Throwable, Environment); it's exists only for binary backward-compatibility.
TemplateException(java.lang.String description, java.lang.Throwable cause, Environment env) Constructs a TemplateException with both a description of the error that occurred and the underlying Exception that caused this exception to be raised.
TemplateException(java.lang.Throwable cause, Environment env) Constructs a TemplateException with the given underlying Exception, but no detail message.
TemplateException(java.lang.Throwable cause, Environment env, freemarker.core.Expression blamedExpr, freemarker.core._ErrorDescriptionBuilder descriptionBuilder) Don't use this; this is to be used internally by FreeMarker.
TemplateModelException(java.lang.Throwable cause, Environment env, freemarker.core._ErrorDescriptionBuilder descriptionBuilder, boolean preventAmbiguity) Don't use this; this is to be used internally by FreeMarker.
TemplateModelException(java.lang.Throwable cause, Environment env, java.lang.String description, boolean preventAmbiguity) Don't use this; this is to be used internally by FreeMarker.

Uses of Environment in freemarker.template.utility

Methods in freemarker.template.utility with parameters of type Environment

Modifier and Type	Method and Description
static boolean	StringUtil.matchesName(java.lang.String qname, java.lang.String nodeName, java.lang.String nsURI, Environment env)