A B C D E F G H I K M N O P Q R S T U V W

A

accept(RouteParameter.Visitor<T>) - Method in class org.jooby.apitool.RouteParameter

Apply a RouteParameter.Visitor and returns the computed result.

accept(RouteParameter, RouteParameter.Visitor<T>) - Method in enum org.jooby.apitool.RouteParameter.Kind

ApiParser - Class in org.jooby.apitool

Parse and extract route metadata from bytecode and documentation from source code.

ApiParser(Path, Predicate<RouteMethod>) - Constructor for class org.jooby.apitool.ApiParser

Creates a new ApiParser.

ApiParser(Path) - Constructor for class org.jooby.apitool.ApiParser

Creates a new ApiParser.

ApiTool - Class in org.jooby.apitool

API tool

ApiTool(Path) - Constructor for class org.jooby.apitool.ApiTool

Creates a new instance of ApiTool.

ApiTool() - Constructor for class org.jooby.apitool.ApiTool

Creates a new ApiTool.

ApiTool.Options - Class in org.jooby.apitool

Export options.

attribute(String, Object) - Method in class org.jooby.apitool.RouteMethod

Set route attribute.

attributes() - Method in class org.jooby.apitool.RouteMethod

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

attributes(Map<String, Object>) - Method in class org.jooby.apitool.RouteMethod

Set route attributes.

B

BOOLEAN - Static variable in class org.jooby.apitool.raml.RamlType

Boolean.

build(Raml, List<RouteMethod>) - Static method in class org.jooby.apitool.raml.Raml

Build a Raml object from list of RouteMethod.

C

config() - Method in class org.jooby.apitool.ApiTool

configure(Env, Config, Binder) - Method in class org.jooby.apitool.ApiTool

consumes() - Method in class org.jooby.apitool.RouteMethod

List of media types this route can consumes.

consumes(List<String>) - Method in class org.jooby.apitool.RouteMethod

Set list of consumes media types for this method.

D

DATE_TIME - Static variable in class org.jooby.apitool.raml.RamlType

DateTime.

defaultValue() - Method in class org.jooby.apitool.RouteParameter

Default value.

defaultValue(Object) - Method in class org.jooby.apitool.RouteParameter

Set default value.

define(Type, RamlType) - Method in class org.jooby.apitool.raml.Raml

Define/map a custom Java type to RAML type.

define(Type) - Method in class org.jooby.apitool.raml.Raml

Register a Java type and produces an equivalent RAML type.

description() - Method in class org.jooby.apitool.RouteMethod

Route description.

description(String) - Method in class org.jooby.apitool.RouteMethod

Set route description.

description() - Method in class org.jooby.apitool.RouteParameter

Parameter description (if any).

description(String) - Method in class org.jooby.apitool.RouteParameter

Set parameter description.

description() - Method in class org.jooby.apitool.RouteResponse

Get response description.

description(String) - Method in class org.jooby.apitool.RouteResponse

Set a description.

disableTryIt() - Method in class org.jooby.apitool.ApiTool

Turn off live-testing (try button) for Swagger and Raml.

disableTryIt() - Method in class org.jooby.apitool.ApiTool.Options

Disable try button.

disableUI() - Method in class org.jooby.apitool.ApiTool

Turn off UI for Swagger and Raml.

disableUI() - Method in class org.jooby.apitool.ApiTool.Options

Turn off UI.

E

enums() - Method in class org.jooby.apitool.RouteParameter

List of enum values when the RouteParameter.type() represents an enum.

equals(Object) - Method in class org.jooby.apitool.RouteMethod

export(Path, String) - Method in class org.jooby.apitool.ApiParser

Parse application bytecode, build route methods from it and export all metadata to .json.

F

FILE - Static variable in class org.jooby.apitool.raml.RamlType

File.

filter(Predicate<RouteMethod>) - Method in class org.jooby.apitool.ApiTool

Select which route is going to be exported to Swagger/RAML.

formParameter(String) - Method in class org.jooby.apitool.raml.RamlMethod

Get or create a form parameter using the giving name.

G

getBaseUri() - Method in class org.jooby.apitool.raml.Raml

RAML base uri.

getBody() - Method in class org.jooby.apitool.raml.RamlMethod

Input/Request type.

getChildren() - Method in class org.jooby.apitool.raml.RamlPath

getDefault() - Method in class org.jooby.apitool.raml.RamlParameter

Default value.

getDescription() - Method in class org.jooby.apitool.raml.RamlMethod

Method description.

getDescription() - Method in class org.jooby.apitool.raml.RamlParameter

RAML description.

getDescription() - Method in class org.jooby.apitool.raml.RamlPath

getDescription() - Method in class org.jooby.apitool.raml.RamlResponse

RAML description.

getDisplayName() - Method in class org.jooby.apitool.raml.RamlMethod

Method display name.

getDisplayName() - Method in class org.jooby.apitool.raml.RamlPath

getEnum() - Method in class org.jooby.apitool.raml.RamlParameter

Enum values.

getExample() - Method in class org.jooby.apitool.raml.RamlType

Example type.

getFormParameters() - Method in class org.jooby.apitool.raml.RamlMethod

Form parameters.

getHeaders() - Method in class org.jooby.apitool.raml.RamlMethod

Map of header parameters.

getMaxLength() - Method in class org.jooby.apitool.raml.RamlType

Get max length.

getMediaType() - Method in class org.jooby.apitool.raml.Raml

Get media types.

getMediaType() - Method in class org.jooby.apitool.raml.RamlMethod

Request media types.

getMediaType() - Method in class org.jooby.apitool.raml.RamlResponse

Media type.

getMinLength() - Method in class org.jooby.apitool.raml.RamlType

Get min length.

getName() - Method in class org.jooby.apitool.raml.RamlParameter

Parameter name.

getPattern() - Method in class org.jooby.apitool.raml.RamlType

Type Pattern.

getProperties() - Method in class org.jooby.apitool.raml.RamlType

Object properties.

getProtocols() - Method in class org.jooby.apitool.raml.Raml

Get protocols.

getQueryParameters() - Method in class org.jooby.apitool.raml.RamlMethod

Map of query parameters.

getRef() - Method in class org.jooby.apitool.raml.RamlType

RAML type reference.

getResources() - Method in class org.jooby.apitool.raml.Raml

Get resources.

getResponses() - Method in class org.jooby.apitool.raml.RamlMethod

Map of status codes.

getTitle() - Method in class org.jooby.apitool.raml.Raml

RAML title.

getType() - Method in class org.jooby.apitool.raml.RamlParameter

RAML type.

getType() - Method in class org.jooby.apitool.raml.RamlType

One of string, number, object, etc.

getType() - Method in class org.jooby.apitool.raml.RamlTypeRef

getTypes() - Method in class org.jooby.apitool.raml.Raml

RAML types.

getUriParameters() - Method in class org.jooby.apitool.raml.RamlPath

getVersion() - Method in class org.jooby.apitool.raml.Raml

RAML version.

H

hashCode() - Method in class org.jooby.apitool.RouteMethod

headerParameter(String) - Method in class org.jooby.apitool.raml.RamlMethod

Get or create a header parameter using the giving name.

I

INTEGER - Static variable in class org.jooby.apitool.raml.RamlType

Integer.

isObject() - Method in class org.jooby.apitool.raml.RamlType

True if this type is an object.

isRequired() - Method in class org.jooby.apitool.raml.RamlParameter

True for required parameter.

K

kind() - Method in class org.jooby.apitool.RouteParameter

Parameter kind.

kind(RouteParameter.Kind) - Method in class org.jooby.apitool.RouteParameter

Set parameter kind.

M

method(String) - Method in class org.jooby.apitool.raml.RamlPath

method() - Method in class org.jooby.apitool.RouteMethod

HTTP method: GET, POST, etc.

method(String) - Method in class org.jooby.apitool.RouteMethod

Change/Set route method.

modify(Predicate<RouteMethod>, Consumer<RouteMethod>) - Method in class org.jooby.apitool.ApiParser

Modify one or more route method who matches the filter.

modify(Predicate<RouteMethod>, Consumer<RouteMethod>) - Method in class org.jooby.apitool.ApiTool

Modify one or more route method who matches the filter.

N

name() - Method in class org.jooby.apitool.RouteMethod

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

name(String) - Method in class org.jooby.apitool.RouteMethod

Set route name.

name() - Method in class org.jooby.apitool.RouteParameter

Parameter name.

name(String) - Method in class org.jooby.apitool.RouteParameter

Set parameter name.

newProperty(String, String, boolean, String...) - Method in class org.jooby.apitool.raml.RamlType

Defines a new property.

NUMBER - Static variable in class org.jooby.apitool.raml.RamlType

Number.

O

optional() - Method in class org.jooby.apitool.RouteParameter

True if parameter is optional.

Options(String) - Constructor for class org.jooby.apitool.ApiTool.Options

Creates a new ApiTool.Options object.

org.jooby.apitool - package org.jooby.apitool

org.jooby.apitool.raml - package org.jooby.apitool.raml

P

param(String, Consumer<RouteParameter>) - Method in class org.jooby.apitool.RouteMethod

Find a parameter by name and invoke the given callback.

parameters() - Method in class org.jooby.apitool.RouteMethod

Get all parameters.

parameters(List<RouteParameter>) - Method in class org.jooby.apitool.RouteMethod

Set all route parameters.

parse(String) - Method in class org.jooby.apitool.ApiParser

Parse application bytecode and build route methods from it.

parseFully(Jooby) - Method in class org.jooby.apitool.ApiParser

Parse application bytecode, build route methods from it and merge output with the given routes.

parseFully(String, List<Route.Definition>) - Method in class org.jooby.apitool.ApiParser

Parse application bytecode, build route methods from it and merge output with the given routes.

path(String) - Method in class org.jooby.apitool.raml.Raml

Get a path for the given pattern.

path(String) - Method in class org.jooby.apitool.raml.RamlPath

pattern() - Method in class org.jooby.apitool.RouteMethod

HTTP pattern.

pattern(String) - Method in class org.jooby.apitool.RouteMethod

Set HTTP pattern.

produces() - Method in class org.jooby.apitool.RouteMethod

List of media types this route can produces.

produces(List<String>) - Method in class org.jooby.apitool.RouteMethod

Set list of produces media types for this method.

Q

queryParameter(String) - Method in class org.jooby.apitool.raml.RamlMethod

Get or create a query parameter using the giving name.

R

raml() - Method in class org.jooby.apitool.ApiTool

Mount RAML using at /raml.

raml(String) - Method in class org.jooby.apitool.ApiTool

Mount RAML at the given path.

raml(String, Consumer<Raml>) - Method in class org.jooby.apitool.ApiTool

Mount RAML at the given path and customize RAML objects.

raml(ApiTool.Options) - Method in class org.jooby.apitool.ApiTool

Mount RAML using the given options.

raml(ApiTool.Options, Consumer<Raml>) - Method in class org.jooby.apitool.ApiTool

Mount RAML using the given options.

Raml - Class in org.jooby.apitool.raml

RAML objects for describing a RAML definition file.

Raml() - Constructor for class org.jooby.apitool.raml.Raml

RamlMethod - Class in org.jooby.apitool.raml

RamlMethod(String) - Constructor for class org.jooby.apitool.raml.RamlMethod

Creates a new RAML method.

RamlParameter - Class in org.jooby.apitool.raml

RAML parameter.

RamlParameter(String) - Constructor for class org.jooby.apitool.raml.RamlParameter

RAML parameter.

RamlPath - Class in org.jooby.apitool.raml

RamlPath() - Constructor for class org.jooby.apitool.raml.RamlPath

RamlResponse - Class in org.jooby.apitool.raml

RAML response.

RamlResponse() - Constructor for class org.jooby.apitool.raml.RamlResponse

RamlType - Class in org.jooby.apitool.raml

RAML type which must be either define(Type) or define(Type).

RamlType(String) - Constructor for class org.jooby.apitool.raml.RamlType

Creates a new RAML type.

RamlType(String, String) - Constructor for class org.jooby.apitool.raml.RamlType

Creates a new RAML type.

RamlTypeRef - Class in org.jooby.apitool.raml

RamlTypeRef(String) - Constructor for class org.jooby.apitool.raml.RamlTypeRef

redoc(String) - Method in class org.jooby.apitool.ApiTool.Options

Add ReDoc UI to swagger (has no effects on RAML).

redoc() - Method in class org.jooby.apitool.ApiTool.Options

Add ReDoc UI to swagger (has no effects on RAML).

redoc() - Method in class org.jooby.apitool.ApiTool

Mount ReDoc at /redoc

redoc(String) - Method in class org.jooby.apitool.ApiTool

Mount ReDoc at /redoc

response(Integer) - Method in class org.jooby.apitool.raml.RamlMethod

Get or create a response using the given status code.

response() - Method in class org.jooby.apitool.RouteMethod

Route response metadata.

response(RouteResponse) - Method in class org.jooby.apitool.RouteMethod

Set a route response.

RouteMethod - Class in org.jooby.apitool

Contains all metadata for a Jooby route.

RouteMethod(String, String, RouteResponse) - Constructor for class org.jooby.apitool.RouteMethod

Creates a new RouteMethod.

RouteParameter - Class in org.jooby.apitool

Metadata and runtime information of a HTTP parameter.

RouteParameter(String, RouteParameter.Kind, Type, Object) - Constructor for class org.jooby.apitool.RouteParameter

Creates a new RouteParameter.

RouteParameter.Kind - Enum in org.jooby.apitool

Parameter Kind.

RouteParameter.Visitor<T> - Interface in org.jooby.apitool

Provides visit methods base on parameter kind.

RouteResponse - Class in org.jooby.apitool

Represent a route response type.

RouteResponse(Type) - Constructor for class org.jooby.apitool.RouteResponse

Creates a new RouteResponse.

S

setBaseUri(String) - Method in class org.jooby.apitool.raml.Raml

Set base uri.

setBody(RamlType) - Method in class org.jooby.apitool.raml.RamlMethod

Set input/request type.

setDefault(Object) - Method in class org.jooby.apitool.raml.RamlParameter

Set default value.

setDescription(String) - Method in class org.jooby.apitool.raml.RamlMethod

Set method description.

setDescription(String) - Method in class org.jooby.apitool.raml.RamlParameter

Set description.

setDescription(String) - Method in class org.jooby.apitool.raml.RamlPath

setDescription(String) - Method in class org.jooby.apitool.raml.RamlResponse

Set RAML description.

setDisplayName(String) - Method in class org.jooby.apitool.raml.RamlMethod

Set display name.

setDisplayName(String) - Method in class org.jooby.apitool.raml.RamlPath

setEnum(List<String>) - Method in class org.jooby.apitool.raml.RamlParameter

Set enum values.

setExample(Object) - Method in class org.jooby.apitool.raml.RamlType

Set example type.

setFormParameters(Map<String, RamlParameter>) - Method in class org.jooby.apitool.raml.RamlMethod

Set form parameters.

setHeaders(Map<String, RamlParameter>) - Method in class org.jooby.apitool.raml.RamlMethod

Set header parameters.

setMaxLength(Integer) - Method in class org.jooby.apitool.raml.RamlType

Set max length.

setMediaType(List<String>) - Method in class org.jooby.apitool.raml.Raml

Set media types.

setMediaType(List<String>) - Method in class org.jooby.apitool.raml.RamlMethod

Set media types.

setMediaType(String, RamlType) - Method in class org.jooby.apitool.raml.RamlResponse

Set media type.

setMethods(Map<String, RamlMethod>) - Method in class org.jooby.apitool.raml.RamlPath

setMinLength(Integer) - Method in class org.jooby.apitool.raml.RamlType

Set min length.

setName(String) - Method in class org.jooby.apitool.raml.RamlParameter

Set parameter name.

setPattern(String) - Method in class org.jooby.apitool.raml.RamlType

Set type pattern.

setProtocols(List<String>) - Method in class org.jooby.apitool.raml.Raml

Set protocols.

setQueryParameters(Map<String, RamlParameter>) - Method in class org.jooby.apitool.raml.RamlMethod

Set query parameters.

setRequired(Boolean) - Method in class org.jooby.apitool.raml.RamlParameter

Set required parameter.

setResources(Map<String, RamlPath>) - Method in class org.jooby.apitool.raml.Raml

Set RAML paths.

setResources(Map<String, RamlPath>) - Method in class org.jooby.apitool.raml.RamlPath

setResponses(Map<Integer, RamlResponse>) - Method in class org.jooby.apitool.raml.RamlMethod

Set status codes response.

setTitle(String) - Method in class org.jooby.apitool.raml.Raml

Set RAML title.

setType(RamlType) - Method in class org.jooby.apitool.raml.RamlParameter

Set RAML type.

setUriParameters(Map<String, RamlParameter>) - Method in class org.jooby.apitool.raml.RamlPath

setVersion(String) - Method in class org.jooby.apitool.raml.Raml

Set RAML version.

status() - Method in class org.jooby.apitool.RouteResponse

Get status codes.

status(Map<Integer, String>) - Method in class org.jooby.apitool.RouteResponse

Set status code map.

status(int) - Method in class org.jooby.apitool.RouteResponse

Get a description for given status code.

statusCode() - Method in class org.jooby.apitool.RouteResponse

Status code.

STRING - Static variable in class org.jooby.apitool.raml.RamlType

String.

summary() - Method in class org.jooby.apitool.RouteMethod

API summary.

summary(String) - Method in class org.jooby.apitool.RouteMethod

Set API summary.

swagger() - Method in class org.jooby.apitool.ApiTool

Mount Swagger at /swagger

swagger(String) - Method in class org.jooby.apitool.ApiTool

Mount Swagger at the given path.

swagger(Consumer<Swagger>) - Method in class org.jooby.apitool.ApiTool

Mount Swagger at /swagger and set a customizer.

swagger(String, Consumer<Swagger>) - Method in class org.jooby.apitool.ApiTool

Mount Swagger at the given path and customize Swagger objects.

swagger(ApiTool.Options) - Method in class org.jooby.apitool.ApiTool

Mount Swagger using the given options.

swagger(ApiTool.Options, Consumer<Swagger>) - Method in class org.jooby.apitool.ApiTool

Mount Swagger using the given options.

T

tagger(Function<RouteMethod, String>) - Method in class org.jooby.apitool.ApiTool.Options

Set a custom tagger (a.k.a as groupBy operator).

theme(String) - Method in class org.jooby.apitool.ApiTool.Options

Set default theme.

toArray() - Method in class org.jooby.apitool.raml.RamlType

Build/make an array.

toString() - Method in class org.jooby.apitool.RouteMethod

toString() - Method in class org.jooby.apitool.RouteParameter

toString() - Method in class org.jooby.apitool.RouteResponse

toYaml() - Method in class org.jooby.apitool.raml.Raml

Convert this RAML object to Yaml.

type() - Method in class org.jooby.apitool.RouteParameter

Parameter type.

type(Type) - Method in class org.jooby.apitool.RouteParameter

Set parameter type.

type() - Method in class org.jooby.apitool.RouteResponse

Route return type.

type(Type) - Method in class org.jooby.apitool.RouteResponse

Set return type.

U

uriParameter(String) - Method in class org.jooby.apitool.raml.RamlPath

use(String) - Method in class org.jooby.apitool.ApiTool.Options

Set specification file like swagger.json, api.raml, etc...

use(Path) - Method in class org.jooby.apitool.ApiTool.Options

Set specification file like swagger.json, api.raml, etc...

V

valueOf(String) - Static method in class org.jooby.apitool.raml.RamlType

Get a RAML type from string.

valueOf(String) - Static method in enum org.jooby.apitool.RouteParameter.Kind

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.jooby.apitool.RouteParameter.Kind

Returns an array containing the constants of this enum type, in the order they are declared.

visitBody(RouteParameter) - Method in interface org.jooby.apitool.RouteParameter.Visitor

Callback method for body HTTP parameters.

visitFile(RouteParameter) - Method in interface org.jooby.apitool.RouteParameter.Visitor

Callback method for file upload HTTP parameters.

visitForm(RouteParameter) - Method in interface org.jooby.apitool.RouteParameter.Visitor

Callback method for form HTTP parameters.

visitHeader(RouteParameter) - Method in interface org.jooby.apitool.RouteParameter.Visitor

Callback method for header HTTP parameters.

visitPath(RouteParameter) - Method in interface org.jooby.apitool.RouteParameter.Visitor

Callback method for path HTTP parameters.

visitQuery(RouteParameter) - Method in interface org.jooby.apitool.RouteParameter.Visitor

Callback method for query HTTP parameters.

W

with(ClassLoader) - Method in class org.jooby.apitool.ApiParser

Set a class loader to use.

A B C D E F G H I K M N O P Q R S T U V W