spark.route

Class Routes

java.lang.Object

spark.route.Routes

Direct Known Subclasses:

SimpleRouteMatcher

public class Routes
extends Object

Holds the routes and performs matching from HTTP requests to routes. Works as Sinatra's, ie. if there are more than one match the one that was mapped first is chosen.

Author:

Per Wendel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Routes() Constructor

Method Summary

Modifier and Type	Method and Description
void	add(String route, String acceptType, Object target) Parse and validates a route and adds it
void	clear() ¨Clear all routes
static Routes	create()
RouteMatch	find(HttpMethod httpMethod, String path, String acceptType) finds target for a requested route
List<RouteMatch>	findMultiple(HttpMethod httpMethod, String path, String acceptType) Finds multiple targets for a requested route.
boolean	remove(String path) Removes a particular route from the collection of those that have been previously routed.
boolean	remove(String path, String httpMethod) Removes a particular route from the collection of those that have been previously routed.

Methods inherited from class java.lang.Object

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

Constructor Detail

Routes

protected Routes()

Constructor

Method Detail

create

public static Routes create()

add

public void add(String route,
                String acceptType,
                Object target)

Parse and validates a route and adds it

Parameters:

route - the route path

acceptType - the accept type

target - the invocation target

find

public RouteMatch find(HttpMethod httpMethod,
                       String path,
                       String acceptType)

finds target for a requested route

Parameters:

httpMethod - the http method

path - the path

acceptType - the accept type

Returns:

the target

findMultiple

public List<RouteMatch> findMultiple(HttpMethod httpMethod,
                                     String path,
                                     String acceptType)

Finds multiple targets for a requested route.

Parameters:

httpMethod - the http method

path - the route path

acceptType - the accept type

Returns:

the targets

clear

public void clear()

¨Clear all routes

remove

public boolean remove(String path,
                      String httpMethod)

Removes a particular route from the collection of those that have been previously routed. Search for a previously established routes using the given path and HTTP method, removing any matches that are found.

Parameters:

path - the route path

httpMethod - the http method

Returns:

true if this a matching route has been previously routed

Throws:

IllegalArgumentException - if path is null or blank or if httpMethod is null, blank or an invalid HTTP method

Since:

2.2

remove

public boolean remove(String path)

Removes a particular route from the collection of those that have been previously routed. Search for a previously established routes using the given path and removes any matches that are found.

Parameters:

path - the route path

Returns:

true if this a matching route has been previously routed

Throws:

IllegalArgumentException - if path is null or blank

Since:

2.2