spark.route

Class SimpleRouteMatcher

java.lang.Object

spark.route.SimpleRouteMatcher

public class SimpleRouteMatcher
extends Object

Simple route matcher that is supposed to work exactly as Sinatra's

Author:

Per Wendel

Constructor Summary

Constructors

Constructor and Description
SimpleRouteMatcher() Constructor

Method Summary

Modifier and Type	Method and Description
void	clearRoutes() ¨Clear all routes
RouteMatch	findTargetForRequestedRoute(HttpMethod httpMethod, String path, String acceptType) finds target for a requested route
List<RouteMatch>	findTargetsForRequestedRoute(HttpMethod httpMethod, String path, String acceptType) Finds multiple targets for a requested route.
void	parseValidateAddRoute(String route, String acceptType, Object target) Parse and validates a route and adds it
boolean	removeRoute(String path) Removes a particular route from the collection of those that have been previously routed.
boolean	removeRoute(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

SimpleRouteMatcher

public SimpleRouteMatcher()

Constructor

Method Detail

parseValidateAddRoute

public void parseValidateAddRoute(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

findTargetForRequestedRoute

public RouteMatch findTargetForRequestedRoute(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

findTargetsForRequestedRoute

public List<RouteMatch> findTargetsForRequestedRoute(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

clearRoutes

public void clearRoutes()

¨Clear all routes

removeRoute

public boolean removeRoute(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

removeRoute

public boolean removeRoute(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