org.jooby.apitool

Class RouteMethod

java.lang.Object

org.jooby.apitool.RouteMethod

public class RouteMethod
extends Object

Contains all metadata for a Jooby route. It is similar to Route.Definition but with extra runtime information like parameters, return type and javadoc.

Since:

1.2.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
RouteMethod(String method, String pattern, RouteResponse returns) Creates a new RouteMethod.

Method Summary

Modifier and Type	Method and Description
RouteMethod	attribute(String name, Object value) Set route attribute.
Map<String,Object>	attributes() Route attributes, copy of Route.Definition#attributes()
RouteMethod	attributes(Map<String,Object> attributes) Set route attributes.
List<String>	consumes() List of media types this route can consumes.
RouteMethod	consumes(List<String> consumes) Set list of consumes media types for this method.
Optional<String>	description() Route description.
RouteMethod	description(String description) Set route description.
boolean	equals(Object obj)
int	hashCode()
String	method() HTTP method: GET, POST, etc.
RouteMethod	method(String method) Change/Set route method.
Optional<String>	name() Route name comes from a direct call to Route.Definition#name(String) for script routes or method name for MVC routes.
RouteMethod	name(String name) Set route name.
RouteMethod	param(String name, Consumer<RouteParameter> customizer) Find a parameter by name and invoke the given callback.
List<RouteParameter>	parameters() Get all parameters.
RouteMethod	parameters(List<RouteParameter> parameters) Set all route parameters.
String	pattern() HTTP pattern.
RouteMethod	pattern(String pattern) Set HTTP pattern.
List<String>	produces() List of media types this route can produces.
RouteMethod	produces(List<String> produces) Set list of produces media types for this method.
RouteResponse	response() Route response metadata.
RouteMethod	response(RouteResponse response) Set a route response.
Optional<String>	summary() API summary.
RouteMethod	summary(String summary) Set API summary.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RouteMethod

public RouteMethod(String method,
                   String pattern,
                   RouteResponse returns)

Creates a new RouteMethod.

Parameters:

method - HTTP method: GET, POST, etc.

pattern - Route pattern.

returns - Route response.

Method Detail

method

public String method()

HTTP method: GET, POST, etc.

Returns:

HTTP method: GET, POST, etc.

method

public RouteMethod method(String method)

Change/Set route method.

Parameters:

method - New HTTP method.

Returns:

This method.

pattern

public String pattern()

HTTP pattern.

Returns:

HTTP pattern.

pattern

public RouteMethod pattern(String pattern)

Set HTTP pattern.

Parameters:

pattern - New HTTP Pattern.

Returns:

This method.

name

public Optional<String> name()

Route name comes from a direct call to Route.Definition#name(String) for script routes or method name for MVC routes.

Returns:

Route name or empty.

name

public RouteMethod name(String name)

Set route name.

Parameters:

name - Route name.

Returns:

This method.

parameters

public List<RouteParameter> parameters()

Get all parameters.

Returns:

All parameters.

parameters

public RouteMethod parameters(List<RouteParameter> parameters)

Set all route parameters.

Parameters:

parameters - A nonnull list of parameters.

Returns:

This method.

summary

public Optional<String> summary()

API summary.

Returns:

Summary or empty.

summary

public RouteMethod summary(String summary)

Set API summary.

Parameters:

summary - Summary.

Returns:

This method.

description

public Optional<String> description()

Route description. Usually the javadoc of a script or MVC route.

Returns:

Description or empty.

description

public RouteMethod description(String description)

Set route description.

Parameters:

description - Description.

Returns:

This method.

consumes

public List<String> consumes()

List of media types this route can consumes.

Returns:

List of media types this route can consumes.

consumes

public RouteMethod consumes(List<String> consumes)

Set list of consumes media types for this method.

Parameters:

consumes - Media types.

Returns:

This method.

produces

public List<String> produces()

List of media types this route can produces.

Returns:

List of media types this route can produces.

produces

public RouteMethod produces(List<String> produces)

Set list of produces media types for this method.

Parameters:

produces - Media types.

Returns:

This method.

response

public RouteResponse response()

Route response metadata.

Returns:

Route response.

response

public RouteMethod response(RouteResponse response)

Set a route response.

Parameters:

response - Response.

Returns:

This method.

attributes

public Map<String,Object> attributes()

Route attributes, copy of Route.Definition#attributes()

Returns:

Attributes.

attributes

public RouteMethod attributes(Map<String,Object> attributes)

Set route attributes.

Parameters:

attributes - Attributes.

Returns:

This method.

attribute

public RouteMethod attribute(String name,
                             Object value)

Set route attribute.

Parameters:

name - Attribute name.

value - Attribute value.

Returns:

This method.

param

public RouteMethod param(String name,
                         Consumer<RouteParameter> customizer)

Find a parameter by name and invoke the given callback.

Parameters:

name - Parameter name.

customizer - Success callback.

Returns:

This method.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object