io.norberg.rut

Class Router.Builder<T>

java.lang.Object

io.norberg.rut.Router.Builder<T>

Enclosing class:

Router<T>

public static class Router.Builder<T>
extends Object

Router builder.

Method Summary

Modifier and Type	Method and Description
Router<T>	build() Create a new Router that will route requests to all endpoints registered with route(java.lang.String, java.lang.String, T).
Router.Builder<T>	optionalTrailingSlash(boolean optional) Set trailing slash matching to be optional or not.
Router.Builder<T>	route(Route route, T target) Register a route.
Router.Builder<T>	route(String method, String path, T target) Register a routing path and method.

Methods inherited from class java.lang.Object

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

Method Detail

build

public Router<T> build()

Create a new Router that will route requests to all endpoints registered with route(java.lang.String, java.lang.String, T).

route

public Router.Builder<T> route(String method,
                               String path,
                               T target)

Register a routing path and method.

Parameters:

method - A method that should be accepted for the route.

path - The path of the route.

target - A routing target that will be returned when requests are successfully routed to this route.

route

public Router.Builder<T> route(Route route,
                               T target)

Register a route.

Parameters:

route - The route to register.

target - A routing target that will be returned when requests are successfully routed to this route.

optionalTrailingSlash

public Router.Builder<T> optionalTrailingSlash(boolean optional)

Set trailing slash matching to be optional or not. When configured to be optional, trailing slash in both routed uris/paths and routes are disregarded. E.g., /foo may be routed to /foo/ and conversely /bar/ may be routed to /bar.

Parameters:

optional - true if trailing slashes should be disregarded, false if trailing slashes should be strictly routed.