io.werval.api.routes

Interface RouteBuilder

public interface RouteBuilder

Fluent builder to create new Route instances.

Routes can be parsed from a String or created using this very builder. The toString() method of Route instances created using this builder output a String that is parseable by this builder.

Let's see some routes:

 GET / controllers.Acme.index()
 GET /login controllers.Acme.loginForm()
 POST /login controllers.Acme.login()
 POST /subscribe controllers.Acme.subscribe()
 GET /:nickname controllers.Acme.home( String nickname )
 

Here is a complete example using the API:

 import io.werval.api.routes.Route;
 import io.werval.api.routes.RoutesBuilder;

 import static io.werval.api.routes.RoutesBuilder.p;

 RouteBuilder builder = ... ; //
 Route route = builder.route( "GET" )
      .on( "/foo/:slug/bar/:id" )
      .to( MyController.class, c ->  c.another( p( "id", String.class ), p( "slug", Integer.class, 2 ) ) )
      .build();

 System.out.println( route.toString() );
 

The last line would output:

GET /foo/bar/:id f.q.n.MyController.another( String id, Integer slug = 2 )

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RouteBuilder.RouteDeclaration Route Declaration.
static interface	RouteBuilder.RouteParser Route Parser.

Method Summary

Modifier and Type	Method and Description
static <T> T	d(String name, Class<T> type, T defaultedValue) Record a new method parameter with defaulted value.
static <T> T	f(String name, Class<T> type, T forcedValue) Record a new method parameter with forced value.
static <T> T	p(String name, Class<T> type) Record a new method parameter.
RouteBuilder.RouteParser	parse() Parse Routes from Strings.
RouteBuilder.RouteDeclaration	route() Start a RouteDeclaration.
RouteBuilder.RouteDeclaration	route(Method httpMethod) Start a RouteDeclaration for a HTTP method.
RouteBuilder.RouteDeclaration	route(String httpMethod) Start a RouteDeclaration for a HTTP method.

Method Detail

route

RouteBuilder.RouteDeclaration route()

Start a RouteDeclaration.

Returns:

Empty RouteDeclaration

route

RouteBuilder.RouteDeclaration route(String httpMethod)

Start a RouteDeclaration for a HTTP method.

Parameters:

httpMethod - HTTP method

Returns:

RouteDeclaration using the given HTTP method

route

RouteBuilder.RouteDeclaration route(Method httpMethod)

Start a RouteDeclaration for a HTTP method.

Parameters:

httpMethod - HTTP method

Returns:

RouteDeclaration using the given HTTP method

parse

RouteBuilder.RouteParser parse()

Parse Routes from Strings.

Returns:

Route Parser

p

static <T> T p(String name,
               Class<T> type)

Record a new method parameter.

Type Parameters:

T - the parameterized parameter type

Parameters:

name - the parameter name

type - the parmeter type

Returns:

an ignored default value

f

static <T> T f(String name,
               Class<T> type,
               T forcedValue)

Record a new method parameter with forced value.

Type Parameters:

T - the parameterized parameter type

Parameters:

name - the parameter name

type - the parmeter type

forcedValue - the forced value

Returns:

the forced value

d

static <T> T d(String name,
               Class<T> type,
               T defaultedValue)

Record a new method parameter with defaulted value.

Type Parameters:

T - the parameterized parameter type

Parameters:

name - the parameter name

type - the parmeter type

defaultedValue - the default value

Returns:

the defaulted value