spark

Class Route

java.lang.Object

spark.AbstractRoute

spark.Route

Direct Known Subclasses:

ResponseTransformerRoute, TemplateViewRoute

public abstract class Route
extends AbstractRoute

A Route is built up by a path (for url-matching) and the implementation of the 'handle' method. When a request is made, if present, the matching routes 'handle' method is invoked. The object that is returned from 'handle' will be set to the response body (toString()).

Author:

Per Wendel

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getAcceptType()
abstract Object	handle(Request request, Response response) Invoked when a request is made on this route's corresponding path e.g.
String	render(Object element) This method should render the given element into something that can be send through Response element.

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

Route

protected Route(String path)

Constructor

Parameters:

path - The route path which is used for matching. (e.g. /hello, users/:name)

Route

protected Route(String path,
     String acceptType)

Constructor

Parameters:

path - The route path which is used for matching. (e.g. /hello, users/:name)

acceptType - The accept type which is used for matching.

Method Detail

handle

public abstract Object handle(Request request,
            Response response)

Invoked when a request is made on this route's corresponding path e.g. '/hello'

Parameters:

request - The request object providing information about the HTTP request

response - The response object providing functionality for modifying the response

Returns:

The content to be set in the response

render

public String render(Object element)

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.

Parameters:

element - to be rendered.

Returns:

body content.

getAcceptType

public String getAcceptType()