spark

Class TemplateViewRouteImpl

java.lang.Object

spark.RouteImpl

spark.TemplateViewRouteImpl

All Implemented Interfaces:

Route, Wrapper

public abstract class TemplateViewRouteImpl
extends RouteImpl

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	TemplateViewRouteImpl(String path, String acceptType) Constructor

Method Summary

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

Methods inherited from class spark.RouteImpl

delegate, getAcceptType, handle

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateViewRouteImpl

protected TemplateViewRouteImpl(String path,
                                String acceptType)

Constructor

Parameters:

path - the path

acceptType - the accept type

Method Detail

create

public static TemplateViewRouteImpl create(String path,
                                           TemplateViewRoute route,
                                           TemplateEngine engine)

factory method

Parameters:

path - the path

route - the route

engine - the engine

Returns:

the wrapper template view route

create

public static TemplateViewRouteImpl create(String path,
                                           String acceptType,
                                           TemplateViewRoute route,
                                           TemplateEngine engine)

factory method

Parameters:

path - the path

acceptType - the accept type

route - the route

engine - the engine

Returns:

the wrapper template view route

render

public Object render(Object object)

Description copied from class: RouteImpl

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 RouteImpl

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 Object 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.