org.jooby

Class Route.Collection

java.lang.Object

org.jooby.Route.Collection

All Implemented Interfaces:

Route.Props<Route.Collection>

Enclosing interface:

Route

public static class Route.Collection
extends Object
implements Route.Props<Route.Collection>

Collection of Route.Props useful for registering/setting route options at once. See Router#get(String, String, String, OneArgHandler) and variants.

Since:

0.5.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Collection(Route.Props... definitions) Creates a new collection of route definitions.

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooby.Route.Props

consumes, consumes, excludes, produces, produces

Constructor Detail

Collection

public Collection(Route.Props... definitions)

Creates a new collection of route definitions.

Parameters:

definitions - Collection of route definitions.

Method Detail

name

public Route.Collection name(String name)

Description copied from interface: Route.Props

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)

Specified by:

name in interface Route.Props<Route.Collection>

Parameters:

name - A route's name.

Returns:

This instance.

renderer

public String renderer()

Description copied from interface: Route.Props

Explicit renderer to use or null.

Specified by:

renderer in interface Route.Props<Route.Collection>

Returns:

Explicit renderer to use or null.

renderer

public Route.Collection renderer(String name)

Description copied from interface: Route.Props

Tell jooby what renderer should use to render the output.

Specified by:

renderer in interface Route.Props<Route.Collection>

Parameters:

name - A renderer's name.

Returns:

This instance.

consumes

public Route.Collection consumes(List<MediaType> types)

Description copied from interface: Route.Props

Set the media types the route can consume.

Specified by:

consumes in interface Route.Props<Route.Collection>

Parameters:

types - The media types to test for.

Returns:

This instance.

produces

public Route.Collection produces(List<MediaType> types)

Description copied from interface: Route.Props

Set the media types the route can produces.

Specified by:

produces in interface Route.Props<Route.Collection>

Parameters:

types - The media types to test for.

Returns:

This instance.

attr

public Route.Collection attr(String name,
                             Object value)

Description copied from interface: Route.Props

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

Specified by:

attr in interface Route.Props<Route.Collection>

Parameters:

name - Attribute's name.

value - Attribute's value.

Returns:

This instance.

excludes

public Route.Collection excludes(List<String> excludes)

Description copied from interface: Route.Props

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

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

Specified by:

excludes in interface Route.Props<Route.Collection>

Parameters:

excludes - A path pattern.

Returns:

This instance.

map

public Route.Collection map(Route.Mapper<?> mapper)

Specified by:

map in interface Route.Props<Route.Collection>