org.mojavemvc.views

Class JSP

java.lang.Object

org.mojavemvc.views.JSP

All Implemented Interfaces:

View

public class JSP
extends Object
implements View

An instance of this class is not thread-safe, and should not be cached and/or re-used.

JSP files used in the framework must have a .jsp extension. The JSP servlet in the container must not be re-mapped to handle files with other extensions.

Author:

Luis Antunes

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	attributes
protected String	jsp

Constructor Summary

Constructors

Constructor and Description
JSP(String jsp) Requires the name of the underlying JSP file.
JSP(String jsp, String[] keys, Object[] values)

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(String key)
Map<String,Object>	getAttributes()
String	getJSPName() Returns the name of the underlying JSP file.
<T> T	getModel(Class<T> modelClass) This method is meant to facilitate testing by providing a means of easily getting the model representation described in the class's attributes.
void	render(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is invoked last in the sequence of steps involved in processing a request sent to the FrontController.
void	setAttribute(String key, Object value)
void	setAttributes(Map<String,Object> attributes)
void	setAttributesFromPairs(String[] keys, Object[] values)
void	setModel(Object javaBean)
JSP	withAttribute(String key, Object value)
JSP	withAttributesFromPairs(String[] keys, Object[] values)
JSP	withModel(Object javaBean)

Methods inherited from class java.lang.Object

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

Field Detail

jsp

protected final String jsp

attributes

protected Map<String,Object> attributes

Constructor Detail

JSP

public JSP(String jsp)

Requires the name of the underlying JSP file. If the name is not suffixed with .jsp, the suffix will be added.

Parameters:

jsp - the name of the underlying JSP file represented by this View

JSP

public JSP(String jsp,
   String[] keys,
   Object[] values)

Method Detail

getAttributes

public Map<String,Object> getAttributes()

setAttributes

public void setAttributes(Map<String,Object> attributes)

getAttribute

public Object getAttribute(String key)

withAttribute

public JSP withAttribute(String key,
                Object value)

setAttribute

public void setAttribute(String key,
                Object value)

withAttributesFromPairs

public JSP withAttributesFromPairs(String[] keys,
                          Object[] values)

setAttributesFromPairs

public void setAttributesFromPairs(String[] keys,
                          Object[] values)

withModel

public JSP withModel(Object javaBean)

setModel

public void setModel(Object javaBean)

getModel

public <T> T getModel(Class<T> modelClass)
           throws Exception

This method is meant to facilitate testing by providing a means of easily getting the model representation described in the class's attributes.

Type Parameters:

T - the model class type

Parameters:

modelClass - the model class

Returns:

an instance of the model with values set from any attributes

Throws:

Exception

getJSPName

public String getJSPName()

Returns the name of the underlying JSP file. It will be suffixed with .jsp.

Returns:

the jsp page

render

public void render(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
                   IOException

Description copied from interface: View

This method is invoked last in the sequence of steps involved in processing a request sent to the FrontController. The servlet request can be used to set any attributes, then to obtain a RequestDispatcher for forwarding or including, or the servlet response may be used to send a redirect, for example.

Users should note that any exceptions thrown from this method are not guaranteed to be caught in the FrontController. They may escape to the requestor. Users should handle any exceptions inside the implementation of this method if different behaviour is desired.

Specified by:

render in interface View

Parameters:

request - the servlet request

response - the servlet response

Throws:

javax.servlet.ServletException

IOException