io.jooby

Class RouteSet

java.lang.Object

io.jooby.RouteSet

public class RouteSet
extends Object

Give you access to all routes created inside a Router.path(String, Runnable). Allow to globally apply attributes or metadata.

Since:

2.7.3

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
RouteSet()

Method Summary

Modifier and Type	Method and Description
RouteSet	attribute(String name, Object value) Add one or more attributes applied to this route.
RouteSet	consumes(MediaType... consumes) Add one or more request types (format) consumed by this route.
RouteSet	description(String description) Route description useful for documentation purpose from openAPI generator.
String	getDescription() Route description useful for documentation purpose from openAPI generator.
List<Route>	getRoutes() Sub-routes.
String	getSummary() Route summary useful for documentation purpose from openAPI generator.
List<String>	getTags() Route tags.
RouteSet	produces(MediaType... produces) Add one or more response types (format) produces by this route.
RouteSet	setAttributes(Map<String,Object> attributes) Add one or more attributes applied to this route.
RouteSet	setConsumes(Collection<MediaType> consumes) Add one or more request types (format) consumed by this route.
RouteSet	setDescription(String description) Route description useful for documentation purpose from openAPI generator.
RouteSet	setExecutorKey(String executorKey) Set executor key.
RouteSet	setProduces(Collection<MediaType> produces) Add one or more response types (format) produces by this route.
RouteSet	setRoutes(List<Route> routes) Set sub-routes.
RouteSet	setSummary(String summary) Route summary useful for documentation purpose from openAPI generator.
RouteSet	setTags(List<String> tags) Tag this route.
RouteSet	summary(String summary) Route summary useful for documentation purpose from openAPI generator.
RouteSet	tags(String... tags) Tag this route.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteSet

public RouteSet()

Method Detail

getRoutes

@Nonnull
public List<Route> getRoutes()

Sub-routes. Always empty except when used it from Router.path(String, Runnable) or Router.routes(Runnable).

Returns:

Sub-routes.

setRoutes

@Nonnull
public RouteSet setRoutes(@Nonnull
                                   List<Route> routes)

Set sub-routes.

Parameters:

routes - Sub-routes.

Returns:

This route.

produces

@Nonnull
public RouteSet produces(@Nonnull
                                  MediaType... produces)

Add one or more response types (format) produces by this route.

Parameters:

produces - Produce types.

Returns:

This route.

setProduces

@Nonnull
public RouteSet setProduces(@Nonnull
                                     Collection<MediaType> produces)

Add one or more response types (format) produces by this route.

Parameters:

produces - Produce types.

Returns:

This route.

consumes

@Nonnull
public RouteSet consumes(@Nonnull
                                  MediaType... consumes)

Add one or more request types (format) consumed by this route.

Parameters:

consumes - Consume types.

Returns:

This route.

setConsumes

@Nonnull
public RouteSet setConsumes(@Nonnull
                                     Collection<MediaType> consumes)

Add one or more request types (format) consumed by this route.

Parameters:

consumes - Consume types.

Returns:

This route.

setAttributes

@Nonnull
public RouteSet setAttributes(@Nonnull
                                       Map<String,Object> attributes)

Add one or more attributes applied to this route.

Parameters:

attributes - .

Returns:

This route.

attribute

@Nonnull
public RouteSet attribute(@Nonnull
                                   String name,
                                   @Nonnull
                                   Object value)

Add one or more attributes applied to this route.

Parameters:

name - attribute name

value - attribute value

Returns:

This route.

setExecutorKey

@Nonnull
public RouteSet setExecutorKey(@Nullable
                                        String executorKey)

Set executor key. The route is going to use the given key to fetch an executor. Possible values are: - null: no specific executor, uses the default Jooby logic to choose one, based on the value of ExecutionMode; - worker: use the executor provided by the server. - arbitrary name: use an named executor which as registered using Router.executor(String, Executor).

Parameters:

executorKey - Executor key.

Returns:

This route.

getTags

@Nonnull
public List<String> getTags()

Route tags.

Returns:

Route tags.

setTags

@Nonnull
public RouteSet setTags(@Nonnull
                                 List<String> tags)

Tag this route. Tags are used for documentation purpose from openAPI generator.

Parameters:

tags - Tags.

Returns:

This route.

tags

@Nonnull
public RouteSet tags(@Nonnull
                              String... tags)

Tag this route. Tags are used for documentation purpose from openAPI generator.

Parameters:

tags - Tags.

Returns:

This route.

getSummary

@Nullable
public String getSummary()

Route summary useful for documentation purpose from openAPI generator.

Returns:

Summary.

summary

@Nonnull
public RouteSet summary(@Nullable
                                 String summary)

Route summary useful for documentation purpose from openAPI generator.

Parameters:

summary - Summary.

Returns:

This route.

setSummary

@Nonnull
public RouteSet setSummary(@Nullable
                                    String summary)

Route summary useful for documentation purpose from openAPI generator.

Parameters:

summary - Summary.

Returns:

This route.

getDescription

@Nullable
public String getDescription()

Route description useful for documentation purpose from openAPI generator.

Returns:

Route description.

setDescription

@Nonnull
public RouteSet setDescription(@Nullable
                                        String description)

Route description useful for documentation purpose from openAPI generator.

Parameters:

description - Description.

Returns:

This route.

description

@Nonnull
public RouteSet description(@Nullable
                                     String description)

Route description useful for documentation purpose from openAPI generator.

Parameters:

description - Description.

Returns:

This route.