Package dev.voidframework.web.http.routing

Interface Router

All Known Implementing Classes:

DefaultRouter

public interface Router

Router.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
void	addRoute(HttpMethod httpMethod, RouteURL routeURL, Class<?> controllerClassType, Method method)	Adds a new route.
void	addRoute(HttpMethod httpMethod, RouteURL routeURL, Class<?> controllerClassType, Method method, String name)	Adds a new route.
List<Route>	getRoutesAsList()	Retrieves all registered routes.
Map<HttpMethod,List<Route>>	getRoutesAsMap()	Retrieves all registered routes.
ResolvedRoute	resolveRoute(HttpMethod httpMethod, String uri)	Resolves a route.
String	reverseRoute(String name)	Reverses a route to obtains a URL.
String	reverseRoute(String name, List<Object> parameterList)	Reverses a route to obtains a URL.

Method Details

addRoute

void addRoute(HttpMethod httpMethod,
 RouteURL routeURL,
 Class<?> controllerClassType,
 Method method)

Adds a new route.

Parameters:

httpMethod - The HTTP method (ie: GET)

routeURL - The route URL

controllerClassType - The controller class type

method - The method to

Since:

1.0.0

addRoute

void addRoute(HttpMethod httpMethod,
 RouteURL routeURL,
 Class<?> controllerClassType,
 Method method,
 String name)

Adds a new route.

Parameters:

httpMethod - The HTTP method (ie: GET)

routeURL - The route URL

controllerClassType - The controller class type

method - The method to call

name - The route name

Since:

1.0.0

resolveRoute

ResolvedRoute resolveRoute(HttpMethod httpMethod,
 String uri)

Resolves a route.

Parameters:

httpMethod - The HTTP method (ie: GET)

uri - The URI to parse to resolve route

Returns:

The resolved route, otherwise, null

Since:

1.0.0

reverseRoute

String reverseRoute(String name)

Reverses a route to obtains a URL.

Parameters:

name - The route name

Returns:

A string containing a URL

Since:

1.0.0

reverseRoute

String reverseRoute(String name,
 List<Object> parameterList)

Reverses a route to obtains a URL.

Parameters:

name - The route name

parameterList - The parameters to use

Returns:

A string containing a URL

Since:

1.0.0

getRoutesAsList

List<Route> getRoutesAsList()

Retrieves all registered routes.

Returns:

All registered routes as List

Since:

1.0.0

getRoutesAsMap

Map<HttpMethod,List<Route>> getRoutesAsMap()

Retrieves all registered routes.

Returns:

All registered routes as Map

Since:

1.0.0