java.lang.Object
- org.jooby.Route.Definition

All Implemented Interfaces:: Route.Props<Route.Definition>

Direct Known Subclasses:: Route.AssetDefinition

Enclosing interface:: Route

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

DSL for customize routes.

Some examples:

   public class MyApp extends Jooby {
     {
        get("/", ()  -> "GET");

        post("/", req  -> "POST");

        put("/", (req, rsp)  -> rsp.send("PUT"));
     }
   }

Setting what a route can consumes

   public class MyApp extends Jooby {
     {
        post("/", (req, resp)  -> resp.send("POST"))
          .consumes(MediaType.json);
     }
   }

Setting what a route can produces

   public class MyApp extends Jooby {
     {
        post("/", (req, resp)  -> resp.send("POST"))
          .produces(MediaType.json);
     }
   }

Adding a name

   public class MyApp extends Jooby {
     {
        post("/", (req, resp)  -> resp.send("POST"))
          .name("My Root");
     }
   }

Since:: 0.1.0
Author:: edgar

Constructor Summary

Constructors
Constructor and Description
`Definition(String method, String pattern, Route.Filter filter)` Creates a new route definition.
`Definition(String method, String pattern, Route.Filter filter, boolean caseSensitiveRouting)` Creates a new route definition.
`Definition(String verb, String pattern, Route.Handler handler)` Creates a new route definition.
`Definition(String verb, String pattern, Route.Handler handler, boolean caseSensitiveRouting)` Creates a new route definition.
`Definition(String verb, String pattern, Route.OneArgHandler handler)` Creates a new route definition.
`Definition(String verb, String pattern, Route.ZeroArgHandler handler)` Creates a new route definition.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`attr(String name)` Get an attribute by name.
`Route.Definition`	`attr(String name, Object value)` Set route attribute.
`Map<String,Object>`	`attributes()`
`boolean`	`canConsume(MediaType type)` Test if the route definition can consume a media type.
`boolean`	`canConsume(String type)` Test if the route definition can consume a media type.
`boolean`	`canProduce(List<MediaType> types)` Test if the route definition can consume a media type.
`boolean`	`canProduce(MediaType... types)` Test if the route definition can consume a media type.
`boolean`	`canProduce(String... types)` Test if the route definition can consume a media type.
`List<MediaType>`	`consumes()`
`Route.Definition`	`consumes(List<MediaType> types)` Set the media types the route can consume.
`Route.Definition`	`declaringClass(String declaringClass)` Set the class where this route is defined.
`List<String>`	`excludes()`
`Route.Definition`	`excludes(List<String> excludes)` Excludes one or more path pattern from this route, useful for filter:
`Route.Filter`	`filter()`
`boolean`	`glob()` Indicates if the `pattern()` contains a glob charecter, like `?`, `` or `*`.
`Route.Definition`	`line(int line)` Set the line where this route is defined.
`Route.Definition`	`map(Route.Mapper<?> mapper)`
`Optional<Route>`	`matches(String method, String path, MediaType contentType, List<MediaType> accept)` Test if the route matches the given verb, path, content type and accept header.
`String`	`method()`
`String`	`name()` Route's name, helpful for debugging but also to implement dynamic and advanced routing.
`Route.Definition`	`name(String name)` Set the route name.
`String`	`pattern()` Path Patterns
`List<MediaType>`	`produces()`
`Route.Definition`	`produces(List<MediaType> types)` Set the media types the route can produces.
`String`	`renderer()` Explicit renderer to use or `null`.
`Route.Definition`	`renderer(String name)` Tell jooby what renderer should use to render the output.
`String`	`reverse(Map<String,Object> vars)` Recreate a route path and apply the given variables.
`String`	`reverse(Object... values)` Recreate a route path and apply the given variables.
`Route.Source`	`source()` Source information (where the route was defined).
`String`	`toString()`
`List<String>`	`vars()`

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

Methods inherited from interface org.jooby.Route.Props
consumes, consumes, excludes, produces, produces

- Constructor Detail
  - Definition
```
public Definition(String verb,
                  String pattern,
                  Route.Handler handler)
```
    Creates a new route definition.
    
    Parameters:
    
    verb - A HTTP verb or *.
    
    pattern - A path pattern.
    
    handler - A route handler.
  - Definition
```
public Definition(String verb,
                  String pattern,
                  Route.Handler handler,
                  boolean caseSensitiveRouting)
```
    Creates a new route definition.
    
    Parameters:
    
    verb - A HTTP verb or *.
    
    pattern - A path pattern.
    
    handler - A route handler.
    
    caseSensitiveRouting - Configure case for routing algorithm.
  - Definition
```
public Definition(String verb,
                  String pattern,
                  Route.OneArgHandler handler)
```
    Creates a new route definition.
    
    Parameters:
    
    verb - A HTTP verb or *.
    
    pattern - A path pattern.
    
    handler - A route handler.
  - Definition
```
public Definition(String verb,
                  String pattern,
                  Route.ZeroArgHandler handler)
```
    Creates a new route definition.
    
    Parameters:
    
    verb - A HTTP verb or *.
    
    pattern - A path pattern.
    
    handler - A route handler.
  - Definition
```
public Definition(String method,
                  String pattern,
                  Route.Filter filter)
```
    Creates a new route definition.
    
    Parameters:
    
    method - A HTTP verb or *.
    
    pattern - A path pattern.
    
    filter - A callback to execute.
  - Definition
```
public Definition(String method,
                  String pattern,
                  Route.Filter filter,
                  boolean caseSensitiveRouting)
```
    Creates a new route definition.
    
    Parameters:
    
    method - A HTTP verb or *.
    
    pattern - A path pattern.
    
    filter - A callback to execute.
    
    caseSensitiveRouting - Configure case for routing algorithm.
- Method Detail
  - pattern
```
@Nonnull
public String pattern()
```
    Path Patterns
    
    Jooby supports Ant-style path patterns:
    
    Some examples:
    - com/t?st.html - matches com/test.html but also com/tast.jsp or com/txst.html
    - com/*.html - matches all .html files in the com directory
    - com/**/test.html - matches all test.html files underneath the com path
    - **/* - matches any path at any level.
    - * - matches any path at any level, shorthand for **/*.
    Variables
    
    Jooby supports path parameters too:
    
    Some examples:
    - /user/{id} - /user/* and give you access to the id var.
    - /user/:id - /user/* and give you access to the id var.
    - /user/{id:\\d+} - /user/[digits] and give you access to the numeric id var.
    Returns:
    
    A path pattern.
  - renderer
```
@Nullable
public String renderer()
```
    Description copied from interface: Route.Props
    
    Explicit renderer to use or null.
    
    Specified by:
    
    renderer in interface Route.Props<Route.Definition>
    
    Returns:
    
    Explicit renderer to use or null.
  - renderer
```
public Route.Definition 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.Definition>
    
    Parameters:
    
    name - A renderer's name.
    
    Returns:
    
    This instance.
  - vars
```
@Nonnull
public List<String> vars()
```
    Returns:
    
    List of path variables (if any).
  - glob
```
@Nonnull
public boolean glob()
```
    Indicates if the pattern() contains a glob charecter, like ?, * or **.
    
    Returns:
    
    Indicates if the pattern() contains a glob charecter, like ?, * or **.
  - source
```
@Nonnull
public Route.Source source()
```
    Source information (where the route was defined).
    
    Returns:
    
    Source information (where the route was defined).
  - reverse
```
@Nonnull
public String reverse(Map<String,Object> vars)
```
    Recreate a route path and apply the given variables.
    
    Parameters:
    
    vars - Path variables.
    
    Returns:
    
    A route pattern.
  - reverse
```
@Nonnull
public String reverse(Object... values)
```
    Recreate a route path and apply the given variables.
    
    Parameters:
    
    values - Path variable values.
    
    Returns:
    
    A route pattern.
  - attr
```
@Nonnull
public Route.Definition 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.Definition>
    
    Parameters:
    
    name - Attribute's name.
    
    value - Attribute's value.
    
    Returns:
    
    This instance.
  - attr
```
@Nonnull
public <T> T attr(String name)
```
    Get an attribute by name.
    
    Type Parameters:
    
    T - Attribute's type.
    
    Parameters:
    
    name - Attribute's name.
    
    Returns:
    
    Attribute's value or null.
  - attributes
```
@Nonnull
public Map<String,Object> attributes()
```
    Returns:
    
    A read only view of attributes.
  - matches
```
@Nonnull
public Optional<Route> matches(String method,
                                        String path,
                                        MediaType contentType,
                                        List<MediaType> accept)
```
    Test if the route matches the given verb, path, content type and accept header.
    
    Parameters:
    
    method - A HTTP verb.
    
    path - Current HTTP path.
    
    contentType - The Content-Type header.
    
    accept - The Accept header.
    
    Returns:
    
    A route or an empty optional.
  - method
```
@Nonnull
public String method()
```
    Returns:
    
    HTTP method or *.
  - filter
```
@Nonnull
public Route.Filter filter()
```
    Returns:
    
    Handler behind this route.
  - name
```
@Nonnull
public String name()
```
    Route's name, helpful for debugging but also to implement dynamic and advanced routing. See Route.Chain.next(String, Request, Response)
    
    Returns:
    
    Route name. Default is: anonymous.
  - name
```
@Nonnull
public Route.Definition 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)
    
    Specified by:
    
    name in interface Route.Props<Route.Definition>
    
    Parameters:
    
    name - A route's name.
    
    Returns:
    
    This definition.
  - canConsume
```
public boolean canConsume(MediaType type)
```
    Test if the route definition can consume a media type.
    
    Parameters:
    
    type - A media type to test.
    
    Returns:
    
    True, if the route can consume the given media type.
  - canConsume
```
public boolean canConsume(String type)
```
    Test if the route definition can consume a media type.
    
    Parameters:
    
    type - A media type to test.
    
    Returns:
    
    True, if the route can consume the given media type.
  - canProduce
```
public boolean canProduce(List<MediaType> types)
```
    Test if the route definition can consume a media type.
    
    Parameters:
    
    types - A media types to test.
    
    Returns:
    
    True, if the route can produces the given media type.
  - canProduce
```
public boolean canProduce(MediaType... types)
```
    Test if the route definition can consume a media type.
    
    Parameters:
    
    types - A media types to test.
    
    Returns:
    
    True, if the route can produces the given media type.
  - canProduce
```
public boolean canProduce(String... types)
```
    Test if the route definition can consume a media type.
    
    Parameters:
    
    types - A media types to test.
    
    Returns:
    
    True, if the route can produces the given media type.
  - consumes
```
public Route.Definition 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.Definition>
    
    Parameters:
    
    types - The media types to test for.
    
    Returns:
    
    This instance.
  - produces
```
public Route.Definition 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.Definition>
    
    Parameters:
    
    types - The media types to test for.
    
    Returns:
    
    This instance.
  - excludes
```
public Route.Definition 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.Definition>
    
    Parameters:
    
    excludes - A path pattern.
    
    Returns:
    
    This instance.
  - excludes
```
@Nonnull
public List<String> excludes()
```
    Returns:
    
    List of exclusion filters (if any).
  - consumes
```
@Nonnull
public List<MediaType> consumes()
```
    Returns:
    
    All the types this route can consumes.
  - produces
```
@Nonnull
public List<MediaType> produces()
```
    Returns:
    
    All the types this route can produces.
  - map
```
@Nonnull
public Route.Definition map(Route.Mapper<?> mapper)
```
    Specified by:
    
    map in interface Route.Props<Route.Definition>
  - line
```
@Nonnull
public Route.Definition line(int line)
```
    Set the line where this route is defined.
    
    Parameters:
    
    line - Line number.
    
    Returns:
    
    This instance.
  - declaringClass
```
@Nonnull
public Route.Definition declaringClass(String declaringClass)
```
    Set the class where this route is defined.
    
    Parameters:
    
    declaringClass - A source class.
    
    Returns:
    
    This instance.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Route.Definition

Setting what a route can consumes

Setting what a route can produces

Adding a name

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jooby.Route.Props

Constructor Detail

Definition

Definition

Definition

Definition

Definition

Definition

Method Detail

pattern

Path Patterns

Variables

renderer

renderer

vars

glob

source

reverse

reverse

attr

attr

attributes

matches

method

filter

name

name

canConsume

canConsume

canProduce

canProduce

canProduce

consumes

produces

excludes

excludes

consumes

produces

map

line

declaringClass

toString