Route (jooby 2.16.0 API)

java.lang.Object
- io.jooby.Route

```
public class Route
extends Object
```
Route contains information about the HTTP method, path pattern, which content types consumes and produces, etc.. Additionally, contains metadata about route return Java type, argument source (query, path, etc..) and Java type. This class contains all the metadata associated to a route. It is like a Class object for routes.

Since:

2.0.0

Author:

edgar

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Route.After` Execute application logic after a response has been generated by a route handler.
`static interface`	`Route.Aware`
`static interface`	`Route.Before` Decorates a handler and run logic before handler is executed.
`static interface`	`Route.Complete` Listener interface for events that are run at the completion of a request/response cycle (i.e.
`static interface`	`Route.Decorator` Decorates a route handler by running logic before and after route handler.
`static interface`	`Route.Handler` Route handler here is where the application logic lives.

Field Summary

Fields
Modifier and Type	Field and Description
`static Route.Before`	`ACCEPT` Handler for `StatusCode.NOT_ACCEPTABLE` responses.
`static Route.Handler`	`FAVICON` Favicon handler as a silent 404 error.
`static Route.Handler`	`METHOD_NOT_ALLOWED` Handler for `StatusCode.METHOD_NOT_ALLOWED` responses.
`static Route.Handler`	`NOT_FOUND` Handler for `StatusCode.NOT_FOUND` responses.
`static Route.Before`	`SUPPORT_MEDIA_TYPE` Handler for `StatusCode.UNSUPPORTED_MEDIA_TYPE` responses.

Constructor Summary

Constructors
Constructor and Description

Route(String method, String pattern, Route.Handler handler)
Creates a new route.

Constructors
Constructor and Description
`Route(String method, String pattern, Route.Handler handler)` Creates a new route.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Route`	`addTag(String tag)` Add a tag to this route.
`<T> T`	`attribute(String name)` Retrieve value of this specific Attribute set to this route.
`Route`	`attribute(String name, Object value)` Add one or more attributes applied to this route.
`Route`	`consumes(MediaType... consumes)` Add one or more request types (format) consumed by this route.
`MessageDecoder`	`decoder(MediaType contentType)` MessageDecoder for given media type.
`Route`	`description(String description)` Route description useful for documentation purpose from openAPI generator.
`Route.After`	`getAfter()` After filter or `null`.
`Map<String,Object>`	`getAttributes()` Attributes set to this route.
`Route.Before`	`getBefore()` Before pipeline or `null`.
`List<MediaType>`	`getConsumes()` Request types (format) consumed by this route.
`Map<String,MessageDecoder>`	`getDecoders()` Route message decoder.
`Route.Decorator`	`getDecorator()` Decorator or `null`.
`String`	`getDescription()` Route description useful for documentation purpose from openAPI generator.
`MessageEncoder`	`getEncoder()` Route encoder.
`String`	`getExecutorKey()` Specify the name of the executor where the route is going to run.
`Object`	`getHandle()` Handler instance which might or might not be the same as `getHandler()`.
`Route.Handler`	`getHandler()` Route handler.
`String`	`getMethod()` HTTP method.
`List<String>`	`getPathKeys()` Path keys.
`String`	`getPattern()` Path pattern.
`Route.Handler`	`getPipeline()` Route pipeline.
`List<MediaType>`	`getProduces()` Response types (format) produces by this route.
`Type`	`getReturnType()` Return return type.
`String`	`getSummary()` Route summary useful for documentation purpose from openAPI generator.
`List<String>`	`getTags()` Route tags.
`boolean`	`isHttpHead()` True if route support HTTP HEAD.
`boolean`	`isHttpOptions()` True if route support HTTP OPTIONS.
`boolean`	`isHttpTrace()` True if route support HTTP TRACE.
`boolean`	`isTransactional(boolean defaultValue)` Returns whether this route is marked as transactional, or returns `defaultValue` if this route has not been marked explicitly.
`Route`	`produces(MediaType... produces)` Add one or more response types (format) produces by this route.
`String`	`reverse(Map<String,Object> keys)` Recreate a path pattern using the given variables.
`String`	`reverse(Object... values)` Recreate a path pattern using the given variables.
`Route`	`setAfter(Route.After after)` Set after filter.
`Route`	`setAttributes(Map<String,Object> attributes)` Add one or more attributes applied to this route.
`Route`	`setBefore(Route.Before before)` Set before filter.
`Route`	`setConsumes(Collection<MediaType> consumes)` Add one or more request types (format) consumed by this route.
`Route`	`setDecoders(Map<String,MessageDecoder> decoders)` Set message decoders.
`Route`	`setDecorator(Route.Decorator decorator)` Set route decorator.
`Route`	`setDescription(String description)` Route description useful for documentation purpose from openAPI generator.
`Route`	`setEncoder(MessageEncoder encoder)` Set encoder.
`Route`	`setExecutorKey(String executorKey)` Set executor key.
`Route`	`setHandle(Object handle)` Set route handle instance, required when handle is different from `getHandler()`.
`Route`	`setHttpHead(boolean enabled)` Enabled or disabled HTTP HEAD.
`Route`	`setHttpOptions(boolean enabled)` Enabled or disabled HTTP Options.
`Route`	`setHttpTrace(boolean enabled)` Enabled or disabled HTTP TRACE.
`Route`	`setPathKeys(List<String> pathKeys)` Set path keys.
`Route`	`setPipeline(Route.Handler pipeline)` Set route pipeline.
`Route`	`setProduces(Collection<MediaType> produces)` Add one or more response types (format) produces by this route.
`Route`	`setReturnType(Type returnType)` Set route return type.
`Route`	`setSummary(String summary)` Route summary useful for documentation purpose from openAPI generator.
`Route`	`setTags(List<String> tags)` Tag this route.
`Route`	`summary(String summary)` Route summary useful for documentation purpose from openAPI generator.
`Route`	`tags(String... tags)` Tag this route.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NOT_FOUND
```
public static final Route.Handler NOT_FOUND
```
    Handler for StatusCode.NOT_FOUND responses.
  - METHOD_NOT_ALLOWED
```
public static final Route.Handler METHOD_NOT_ALLOWED
```
    Handler for StatusCode.METHOD_NOT_ALLOWED responses.
  - ACCEPT
```
public static final Route.Before ACCEPT
```
    Handler for StatusCode.NOT_ACCEPTABLE responses.
  - SUPPORT_MEDIA_TYPE
```
public static final Route.Before SUPPORT_MEDIA_TYPE
```
    Handler for StatusCode.UNSUPPORTED_MEDIA_TYPE responses.
  - FAVICON
```
public static final Route.Handler FAVICON
```
    Favicon handler as a silent 404 error.
- Constructor Detail
  - Route
```
public Route(@Nonnull
             String method,
             @Nonnull
             String pattern,
             @Nonnull
             Route.Handler handler)
```
    Creates a new route.
    
    Parameters:
    
    method - HTTP method.
    
    pattern - Path pattern.
    
    handler - Route handler.
- Method Detail
  - getPattern
```
@Nonnull
public String getPattern()
```
    Path pattern.
    
    Returns:
    
    Path pattern.
  - getMethod
```
@Nonnull
public String getMethod()
```
    HTTP method.
    
    Returns:
    
    HTTP method.
  - getPathKeys
```
@Nonnull
public List<String> getPathKeys()
```
    Path keys.
    
    Returns:
    
    Path keys.
  - setPathKeys
```
@Nonnull
public Route setPathKeys(@Nonnull
                                  List<String> pathKeys)
```
    Set path keys.
    
    Parameters:
    
    pathKeys - Path keys or empty list.
    
    Returns:
    
    This route.
  - getHandler
```
@Nonnull
public Route.Handler getHandler()
```
    Route handler.
    
    Returns:
    
    Route handler.
  - getPipeline
```
@Nonnull
public Route.Handler getPipeline()
```
    Route pipeline.
    
    Returns:
    
    Route pipeline.
  - reverse
```
@Nonnull
public String reverse(@Nonnull
                               Map<String,Object> keys)
```
    Recreate a path pattern using the given variables. reserve(/{k1}/{k2}, {"k1": ""foo", "k2": "bar"}) => /foo/bar
    
    Parameters:
    
    keys - Path keys.
    
    Returns:
    
    Path.
  - reverse
```
@Nonnull
public String reverse(Object... values)
```
    Recreate a path pattern using the given variables. reserve(/{k1}/{k2}, "foo", "bar") => /foo/bar
    
    Parameters:
    
    values - Values.
    
    Returns:
    
    Path.
  - getHandle
```
@Nonnull
public Object getHandle()
```
    Handler instance which might or might not be the same as getHandler(). The handle is required to extract correct metadata.
    
    Returns:
    
    Handle.
  - getBefore
```
@Nullable
public Route.Before getBefore()
```
    Before pipeline or null.
    
    Returns:
    
    Before pipeline or null.
  - setBefore
```
@Nonnull
public Route setBefore(@Nullable
                                Route.Before before)
```
    Set before filter.
    
    Parameters:
    
    before - Before filter.
    
    Returns:
    
    This route.
  - getAfter
```
@Nullable
public Route.After getAfter()
```
    After filter or null.
    
    Returns:
    
    After filter or null.
  - setAfter
```
@Nonnull
public Route setAfter(@Nonnull
                               Route.After after)
```
    Set after filter.
    
    Parameters:
    
    after - After filter.
    
    Returns:
    
    This route.
  - getDecorator
```
@Nullable
public Route.Decorator getDecorator()
```
    Decorator or null.
    
    Returns:
    
    Decorator or null.
  - setDecorator
```
@Nonnull
public Route setDecorator(@Nullable
                                   Route.Decorator decorator)
```
    Set route decorator.
    
    Parameters:
    
    decorator - Decorator.
    
    Returns:
    
    This route.
  - setHandle
```
@Nonnull
public Route setHandle(@Nonnull
                                Object handle)
```
    Set route handle instance, required when handle is different from getHandler().
    
    Parameters:
    
    handle - Handle instance.
    
    Returns:
    
    This route.
  - setPipeline
```
@Nonnull
public Route setPipeline(Route.Handler pipeline)
```
    Set route pipeline. This method is part of public API but isn't intended to be used by public.
    
    Parameters:
    
    pipeline - Pipeline.
    
    Returns:
    
    This routes.
  - getEncoder
```
@Nonnull
public MessageEncoder getEncoder()
```
    Route encoder.
    
    Returns:
    
    Route encoder.
  - setEncoder
```
@Nonnull
public Route setEncoder(@Nonnull
                                 MessageEncoder encoder)
```
    Set encoder.
    
    Parameters:
    
    encoder - MessageEncoder.
    
    Returns:
    
    This route.
  - getReturnType
```
@Nullable
public Type getReturnType()
```
    Return return type.
    
    Returns:
    
    Return type.
  - setReturnType
```
@Nonnull
public Route setReturnType(@Nullable
                                    Type returnType)
```
    Set route return type.
    
    Parameters:
    
    returnType - Return type.
    
    Returns:
    
    This route.
  - getProduces
```
@Nonnull
public List<MediaType> getProduces()
```
    Response types (format) produces by this route. If set, we expect to find a match in the Accept header. If none matches, we send a StatusCode.NOT_ACCEPTABLE response.
    
    Returns:
    
    Immutable list of produce types.
  - produces
```
@Nonnull
public Route 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 Route setProduces(@Nonnull
                                  Collection<MediaType> produces)
```
    Add one or more response types (format) produces by this route.
    
    Parameters:
    
    produces - Produce types.
    
    Returns:
    
    This route.
  - getConsumes
```
@Nonnull
public List<MediaType> getConsumes()
```
    Request types (format) consumed by this route. If set the Content-Type header is checked against these values. If none matches we send a StatusCode.UNSUPPORTED_MEDIA_TYPE exception.
    
    Returns:
    
    Immutable list of consumed types.
  - consumes
```
@Nonnull
public Route 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 Route setConsumes(@Nonnull
                                  Collection<MediaType> consumes)
```
    Add one or more request types (format) consumed by this route.
    
    Parameters:
    
    consumes - Consume types.
    
    Returns:
    
    This route.
  - getAttributes
```
@Nonnull
public Map<String,Object> getAttributes()
```
    Attributes set to this route.
    
    Returns:
    
    Map of attributes set to the route.
  - attribute
```
@Nullable
public <T> T attribute(@Nonnull
                                 String name)
```
    Retrieve value of this specific Attribute set to this route.
    
    Type Parameters:
    
    T - Generic type.
    
    Parameters:
    
    name - of the attribute to retrieve.
    
    Returns:
    
    value of the specific attribute.
  - setAttributes
```
@Nonnull
public Route setAttributes(@Nonnull
                                    Map<String,Object> attributes)
```
    Add one or more attributes applied to this route.
    
    Parameters:
    
    attributes - .
    
    Returns:
    
    This route.
  - attribute
```
@Nonnull
public Route 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.
  - decoder
```
@Nonnull
public MessageDecoder decoder(@Nonnull
                                       MediaType contentType)
```
    MessageDecoder for given media type.
    
    Parameters:
    
    contentType - Media type.
    
    Returns:
    
    MessageDecoder.
  - getDecoders
```
@Nonnull
public Map<String,MessageDecoder> getDecoders()
```
    Route message decoder.
    
    Returns:
    
    Message decoders.
  - setDecoders
```
@Nonnull
public Route setDecoders(@Nonnull
                                  Map<String,MessageDecoder> decoders)
```
    Set message decoders. Map key is a mime-type.
    
    Parameters:
    
    decoders - message decoder.
    
    Returns:
    
    This route.
  - isHttpOptions
```
public boolean isHttpOptions()
```
    True if route support HTTP OPTIONS.
    
    Returns:
    
    True if route support HTTP OPTIONS.
  - isHttpTrace
```
public boolean isHttpTrace()
```
    True if route support HTTP TRACE.
    
    Returns:
    
    True if route support HTTP TRACE.
  - isHttpHead
```
public boolean isHttpHead()
```
    True if route support HTTP HEAD.
    
    Returns:
    
    True if route support HTTP HEAD.
  - setHttpOptions
```
@Nonnull
public Route setHttpOptions(boolean enabled)
```
    Enabled or disabled HTTP Options.
    
    Parameters:
    
    enabled - Enabled or disabled HTTP Options.
    
    Returns:
    
    This route.
  - setHttpTrace
```
@Nonnull
public Route setHttpTrace(boolean enabled)
```
    Enabled or disabled HTTP TRACE.
    
    Parameters:
    
    enabled - Enabled or disabled HTTP TRACE.
    
    Returns:
    
    This route.
  - setHttpHead
```
@Nonnull
public Route setHttpHead(boolean enabled)
```
    Enabled or disabled HTTP HEAD.
    
    Parameters:
    
    enabled - Enabled or disabled HTTP HEAD.
    
    Returns:
    
    This route.
  - getExecutorKey
```
@Nullable
public String getExecutorKey()
```
    Specify the name of the executor where the route is going to run. Default is null.
    
    Returns:
    
    Executor key.
  - setExecutorKey
```
@Nonnull
public Route 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 Route setTags(@Nonnull
                              List<String> tags)
```
    Tag this route. Tags are used for documentation purpose from openAPI generator.
    
    Parameters:
    
    tags - Tags.
    
    Returns:
    
    This route.
  - addTag
```
@Nonnull
public Route addTag(@Nonnull
                             String tag)
```
    Add a tag to this route. Tags are used for documentation purpose from openAPI generator.
    
    Parameters:
    
    tag - Tag.
    
    Returns:
    
    This route.
  - tags
```
@Nonnull
public Route 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 Route summary(@Nullable
                              String summary)
```
    Route summary useful for documentation purpose from openAPI generator.
    
    Parameters:
    
    summary - Summary.
    
    Returns:
    
    This route.
  - setSummary
```
@Nonnull
public Route 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 Route setDescription(@Nullable
                                     String description)
```
    Route description useful for documentation purpose from openAPI generator.
    
    Parameters:
    
    description - Description.
    
    Returns:
    
    This route.
  - description
```
@Nonnull
public Route description(@Nullable
                                  String description)
```
    Route description useful for documentation purpose from openAPI generator.
    
    Parameters:
    
    description - Description.
    
    Returns:
    
    This route.
  - isTransactional
```
public boolean isTransactional(boolean defaultValue)
```
    Returns whether this route is marked as transactional, or returns defaultValue if this route has not been marked explicitly.
    
    Parameters:
    
    defaultValue - the value to return if this route was not explicitly marked
    
    Returns:
    
    whether this route should be considered as transactional
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Route

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOT_FOUND

METHOD_NOT_ALLOWED

ACCEPT

SUPPORT_MEDIA_TYPE

FAVICON

Constructor Detail

Route

Method Detail

getPattern

getMethod

getPathKeys

setPathKeys

getHandler

getPipeline

reverse

reverse

getHandle

getBefore

setBefore

getAfter

setAfter

getDecorator

setDecorator

setHandle

setPipeline

getEncoder

setEncoder

getReturnType

setReturnType

getProduces

produces

setProduces

getConsumes

consumes

setConsumes

getAttributes

attribute

setAttributes

attribute

decoder

getDecoders

setDecoders

isHttpOptions

isHttpTrace

isHttpHead

setHttpOptions

setHttpTrace

setHttpHead

getExecutorKey

setExecutorKey

getTags

setTags

addTag

tags

getSummary

summary

setSummary

getDescription

setDescription

description

isTransactional

toString