Uses of Class
freemarker.core.Environment
Packages that use Environment
Package
Description
Template loading and caching.
The seldom used or advanced parts of the fundamental FreeMarker API, compared to
freemarker.template
.Servlet for legacy "Model 2" frameworks that allows using FreeMarker
templates instead of JSP as the MVC View
(see in the Manual).
The fundamental, most commonly used API-s of FreeMarker;
start with
Configuration
(see also the
Getting Started in the Manual.)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 EnvironmentModifier and TypeMethodDescriptionstatic String
TemplateCache.getFullTemplatePath
(Environment env, String baseName, String targetName) Deprecated. -
Uses of Environment in freemarker.core
Methods in freemarker.core that return EnvironmentModifier and TypeMethodDescriptionstatic Environment
Environment.getCurrentEnvironment()
Retrieves the environment object associated with the current thread, ornull
if there's no template processing going on in this thread.protected Environment
Configurable.getEnvironment()
Methods in freemarker.core with parameters of type EnvironmentModifier and TypeMethodDescriptionprotected void
Configurable.doAutoImportsAndIncludes
(Environment env) Executes the auto-imports and auto-includes for the main template of this environment.AliasTemplateDateFormatFactory.get
(String params, int dateType, Locale locale, TimeZone timeZone, boolean zonelessInput, Environment env) AliasTemplateNumberFormatFactory.get
(String params, Locale locale, Environment env) final Object
CustomAttribute.get
(Environment env) Gets the attribute from the appropriate scope that's accessible through the specifiedEnvironment
.abstract TemplateDateFormat
TemplateDateFormatFactory.get
(String params, int dateType, Locale locale, TimeZone timeZone, boolean zonelessInput, Environment env) Returns a formatter for the given parameters.abstract TemplateNumberFormat
TemplateNumberFormatFactory.get
(String params, Locale locale, Environment env) Returns a formatter for the given parameters.OptInTemplateClassResolver.resolve
(String className, Environment env, Template template) TemplateClassResolver.resolve
(String className, Environment env, Template template) Gets aClass
based on the class name.final void
CustomAttribute.set
(Object value, Environment env) Sets the attribute inside the appropriate scope that's accessible through the specifiedEnvironment
.DefaultTruncateBuiltinAlgorithm.truncate
(String s, int maxLength, TemplateScalarModel terminator, Integer terminatorLength, Environment env) abstract TemplateScalarModel
TruncateBuiltinAlgorithm.truncate
(String s, int maxLength, TemplateScalarModel terminator, Integer terminatorLength, Environment env) Corresponds to?truncate(...)
in templates.DefaultTruncateBuiltinAlgorithm.truncateC
(String s, int maxLength, TemplateScalarModel terminator, Integer terminatorLength, Environment env) abstract TemplateScalarModel
TruncateBuiltinAlgorithm.truncateC
(String s, int maxLength, TemplateScalarModel terminator, Integer terminatorLength, Environment env) Corresponds to?truncate_c_m(...)
in templates.DefaultTruncateBuiltinAlgorithm.truncateCM
(String s, int maxLength, TemplateModel terminator, Integer terminatorLength, Environment env) abstract TemplateModel
TruncateBuiltinAlgorithm.truncateCM
(String s, int maxLength, TemplateModel terminator, Integer terminatorLength, Environment env) Corresponds to?truncate_c_m(...)
in templates.DefaultTruncateBuiltinAlgorithm.truncateM
(String s, int maxLength, TemplateModel terminator, Integer terminatorLength, Environment env) abstract TemplateModel
TruncateBuiltinAlgorithm.truncateM
(String s, int maxLength, TemplateModel terminator, Integer terminatorLength, Environment env) Corresponds to?truncate_m(...)
in templates.DefaultTruncateBuiltinAlgorithm.truncateW
(String s, int maxLength, TemplateScalarModel terminator, Integer terminatorLength, Environment env) abstract TemplateScalarModel
TruncateBuiltinAlgorithm.truncateW
(String s, int maxLength, TemplateScalarModel terminator, Integer terminatorLength, Environment env) Corresponds to?truncate_w(...)
in templates.DefaultTruncateBuiltinAlgorithm.truncateWM
(String s, int maxLength, TemplateModel terminator, Integer terminatorLength, Environment env) abstract TemplateModel
TruncateBuiltinAlgorithm.truncateWM
(String s, int maxLength, TemplateModel terminator, Integer terminatorLength, Environment env) Corresponds to?truncate_w_m(...)
in templates.Constructors in freemarker.core with parameters of type EnvironmentModifierConstructorDescriptionCreates and invalid reference exception that contains no information about what was missing or null.InvalidReferenceException
(String description, Environment env) Creates and invalid reference exception that contains no programmatically extractable information about the blamed expression.NonBooleanException
(String description, Environment env) NonDateException
(String description, Environment env) NonExtendedHashException
(String description, Environment env) NonExtendedNodeException
(String description, Environment env) NonHashException
(String description, Environment env) NonMarkupOutputException
(String description, Environment env) NonMethodException
(String description, Environment env) NonNodeException
(String description, Environment env) NonNumericalException
(String description, Environment env) NonSequenceException
(String description, Environment env) NonSequenceOrCollectionException
(String description, Environment env) NonStringException
(String description, Environment env) NonStringOrTemplateOutputException
(String description, Environment env) UnexpectedTypeException
(Environment env, String description) -
Uses of Environment in freemarker.ext.servlet
Methods in freemarker.ext.servlet with parameters of type EnvironmentModifier and TypeMethodDescriptionvoid
IncludePage.execute
(Environment env, 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 EnvironmentModifier and TypeMethodDescriptionTemplate.createProcessingEnvironment
(Object dataModel, Writer out) Template.createProcessingEnvironment
(Object dataModel, Writer out, ObjectWrapper wrapper) Creates aEnvironment
object, using this template, the data-model provided as parameter.TemplateException.getEnvironment()
Methods in freemarker.template with parameters of type EnvironmentModifier and TypeMethodDescriptionprotected void
Configuration.doAutoImportsAndIncludes
(Environment env) void
TemplateDirectiveModel.execute
(Environment env, 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, Writer out) Method called after aTemplateException
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 EnvironmentModifierConstructorDescriptionConstructs a TemplateException with no specified detail message or underlying cause.TemplateException
(Exception cause, Environment env) The same asTemplateException(Throwable, Environment)
; it's exists only for binary backward-compatibility.TemplateException
(String description, Environment env) Constructs a TemplateException with the given detail message, but no underlying cause exception.TemplateException
(String description, Exception cause, Environment env) The same asTemplateException(String, Throwable, Environment)
; it's exists only for binary backward-compatibility.TemplateException
(String description, 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
(Throwable cause, Environment env) Constructs a TemplateException with the given underlying Exception, but no detail message.protected
TemplateException
(Throwable cause, Environment env, freemarker.core.Expression blamedExpr, freemarker.core._ErrorDescriptionBuilder descriptionBuilder) Don't use this; this is to be used internally by FreeMarker.protected
TemplateModelException
(Throwable cause, Environment env, freemarker.core._ErrorDescriptionBuilder descriptionBuilder, boolean preventAmbiguity) Don't use this; this is to be used internally by FreeMarker.protected
TemplateModelException
(Throwable cause, Environment env, 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 EnvironmentModifier and TypeMethodDescriptionstatic boolean
StringUtil.matchesName
(String qname, String nodeName, String nsURI, Environment env)
toFullTemplateName(String, String)
instead, as that can throwMalformedTemplateNameException
, and is on a more logical place anyway.