org.jooby

Interface Route.Props<T extends Route.Props<T>>

Type Parameters:

T - Attribute subtype.

All Known Implementing Classes:

Route.Collection, Route.Definition, Route.Group

Enclosing interface:

Route

public static interface Route.Props<T extends Route.Props<T>>

Common route properties, like static and global metadata via attributes, path exclusion, produces and consumes types.

Since:

1.0.0.CR

Author:

edgar

Method Summary

Modifier and Type	Method and Description
T	attr(String name, Object value) Set route attribute.
T	consumes(List<MediaType> consumes) Set the media types the route can consume.
default T	consumes(MediaType... consumes) Set the media types the route can consume.
default T	consumes(String... consumes) Set the media types the route can consume.
T	excludes(List<String> excludes) Excludes one or more path pattern from this route, useful for filter:
default T	excludes(String... excludes) Excludes one or more path pattern from this route, useful for filter:
T	map(Route.Mapper<?> mapper)
T	name(String name) Set the route name.
T	produces(List<MediaType> produces) Set the media types the route can produces.
default T	produces(MediaType... produces) Set the media types the route can produces.
default T	produces(String... produces) Set the media types the route can produces.
String	renderer() Explicit renderer to use or null.
T	renderer(String name) Tell jooby what renderer should use to render the output.

Method Detail

attr

@Nonnull
T attr(String name,
                Object value)

Set route attribute. Only primitives, string, class, enum or array of previous types are allowed as attributes values.

Parameters:

name - Attribute's name.

value - Attribute's value.

Returns:

This instance.

renderer

@Nonnull
T renderer(String name)

Tell jooby what renderer should use to render the output.

Parameters:

name - A renderer's name.

Returns:

This instance.

renderer

@Nullable
String renderer()

Explicit renderer to use or null.

Returns:

Explicit renderer to use or null.

name

@Nonnull
T name(String name)

Set the route name. Route's name, helpful for debugging but also to implement dynamic and advanced routing. See Route.Chain.next(String, Request, Response)

Parameters:

name - A route's name.

Returns:

This instance.

consumes

@Nonnull
default T consumes(MediaType... consumes)

Set the media types the route can consume.

Parameters:

consumes - The media types to test for.

Returns:

This instance.

consumes

@Nonnull
default T consumes(String... consumes)

Set the media types the route can consume.

Parameters:

consumes - The media types to test for.

Returns:

This instance.

consumes

@Nonnull
T consumes(List<MediaType> consumes)

Set the media types the route can consume.

Parameters:

consumes - The media types to test for.

Returns:

This instance.

produces

@Nonnull
default T produces(MediaType... produces)

Set the media types the route can produces.

Parameters:

produces - The media types to test for.

Returns:

This instance.

produces

@Nonnull
default T produces(String... produces)

Set the media types the route can produces.

Parameters:

produces - The media types to test for.

Returns:

This instance.

produces

@Nonnull
T produces(List<MediaType> produces)

Set the media types the route can produces.

Parameters:

produces - The media types to test for.

Returns:

This instance.

excludes

@Nonnull
default T excludes(String... excludes)

Excludes one or more path pattern from this route, useful for filter:

 {
   use("*", req  -> {
    ...
   }).excludes("/logout");
 }
 

Parameters:

excludes - A path pattern.

Returns:

This instance.

excludes

@Nonnull
T excludes(List<String> excludes)

Excludes one or more path pattern from this route, useful for filter:

 {
   use("*", req  -> {
    ...
   }).excludes("/logout");
 }
 

Parameters:

excludes - A path pattern.

Returns:

This instance.

map

@Nonnull
T map(Route.Mapper<?> mapper)