Package freemarker.ext.servlet
Class HttpSessionHashModel
- java.lang.Object
-
- freemarker.ext.servlet.HttpSessionHashModel
-
- All Implemented Interfaces:
TemplateHashModel
,TemplateModel
,java.io.Serializable
public final class HttpSessionHashModel extends java.lang.Object implements TemplateHashModel, java.io.Serializable
TemplateHashModel wrapper for a HttpSession attributes.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface freemarker.template.TemplateModel
NOTHING
-
-
Constructor Summary
Constructors Constructor Description HttpSessionHashModel(FreemarkerServlet servlet, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ObjectWrapper wrapper)
Use this constructor when the session isn't already created.HttpSessionHashModel(javax.servlet.http.HttpSession session, ObjectWrapper wrapper)
Use this constructor when the session already exists.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TemplateModel
get(java.lang.String key)
Gets a TemplateModel from the hash.boolean
isEmpty()
-
-
-
Constructor Detail
-
HttpSessionHashModel
public HttpSessionHashModel(javax.servlet.http.HttpSession session, ObjectWrapper wrapper)
Use this constructor when the session already exists.- Parameters:
session
- the sessionwrapper
- an object wrapper used to wrap session attributes
-
HttpSessionHashModel
public HttpSessionHashModel(FreemarkerServlet servlet, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ObjectWrapper wrapper)
Use this constructor when the session isn't already created. It is passed enough parameters so that the session can be properly initialized after it's detected that it was created.- Parameters:
servlet
- the FreemarkerServlet that created this model. If the model is not created through FreemarkerServlet, leave this argument as null.request
- the actual requestresponse
- the actual responsewrapper
- an object wrapper used to wrap session attributes
-
-
Method Detail
-
get
public TemplateModel get(java.lang.String key) throws TemplateModelException
Description copied from interface:TemplateHashModel
Gets a TemplateModel from the hash.- Specified by:
get
in interfaceTemplateHashModel
- Parameters:
key
- 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
-
isEmpty
public boolean isEmpty() throws TemplateModelException
- Specified by:
isEmpty
in interfaceTemplateHashModel
- Throws:
TemplateModelException
-
-