spark

Class TemplateViewRoute

java.lang.Object

spark.AbstractRoute

spark.Route

spark.TemplateViewRoute

public abstract class TemplateViewRoute
extends Route

A TemplateViewRoute is built up by a path (for url-matching) and the implementation of the 'render' method. TemplateViewRoute instead of returning the result of calling toString() as body, it returns the result of calling render method. The primary purpose of this kind of Route is provide a way to create generic and reusable components for rendering output using a Template Engine. For example to render objects to html by using Freemarker template engine..

Author:

alex

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TemplateViewRoute(String path)
protected	TemplateViewRoute(String path, String acceptType)

Method Summary

Methods

Modifier and Type	Method and Description
ModelAndView	modelAndView(Object model, String viewName) Creates a new ModelAndView object with given arguments.
abstract String	render(ModelAndView modelAndView) Method called to render the output that is sent to client.
String	render(Object object) This method should render the given element into something that can be send through Response element.

Methods inherited from class spark.Route

getAcceptType, handle

Methods inherited from class spark.AbstractRoute

halt, halt, halt, halt

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateViewRoute

protected TemplateViewRoute(String path)

TemplateViewRoute

protected TemplateViewRoute(String path,
                 String acceptType)

Method Detail

render

public String render(Object object)

Description copied from class: Route

This method should render the given element into something that can be send through Response element. By default this method returns the result of calling toString method in given element, but can be overridden.

Overrides:

render in class Route

Parameters:

object - to be rendered.

Returns:

body content.

modelAndView

public ModelAndView modelAndView(Object model,
                        String viewName)

Creates a new ModelAndView object with given arguments.

Parameters:

model - object.

viewName - t be rendered.

Returns:

object with model and view set.

render

public abstract String render(ModelAndView modelAndView)

Method called to render the output that is sent to client.

Parameters:

modelAndView - object where object (mostly a POJO) and the name of the view to render are set.

Returns:

message that it is sent to client.