org.jooby.apitool.raml

Class RamlMethod

java.lang.Object

org.jooby.apitool.raml.RamlMethod

public class RamlMethod
extends Object

Constructor Summary

Constructors

Constructor and Description
RamlMethod(String name) Creates a new RAML method.

Method Summary

Modifier and Type	Method and Description
RamlParameter	formParameter(String name) Get or create a form parameter using the giving name.
RamlType	getBody() Input/Request type.
String	getDescription() Method description.
String	getDisplayName() Method display name.
Map<String,RamlParameter>	getFormParameters() Form parameters.
Map<String,RamlParameter>	getHeaders() Map of header parameters.
List<String>	getMediaType() Request media types.
Map<String,RamlParameter>	getQueryParameters() Map of query parameters.
Map<Integer,RamlResponse>	getResponses() Map of status codes.
RamlParameter	headerParameter(String name) Get or create a header parameter using the giving name.
RamlParameter	queryParameter(String name) Get or create a query parameter using the giving name.
RamlResponse	response(Integer status) Get or create a response using the given status code.
void	setBody(RamlType body) Set input/request type.
void	setDescription(String description) Set method description.
void	setDisplayName(String displayName) Set display name.
void	setFormParameters(Map<String,RamlParameter> formParameters) Set form parameters.
void	setHeaders(Map<String,RamlParameter> headers) Set header parameters.
void	setMediaType(List<String> mediaType) Set media types.
void	setQueryParameters(Map<String,RamlParameter> queryParameters) Set query parameters.
void	setResponses(Map<Integer,RamlResponse> responses) Set status codes response.

Methods inherited from class java.lang.Object

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

Constructor Detail

RamlMethod

public RamlMethod(String name)

Creates a new RAML method.

Parameters:

name - Method name.

Method Detail

getBody

public RamlType getBody()

Input/Request type.

Returns:

Input/Request type.

setBody

public void setBody(RamlType body)

Set input/request type.

Parameters:

body - RAML type.

getDisplayName

public String getDisplayName()

Method display name.

Returns:

Display name.

setDisplayName

public void setDisplayName(String displayName)

Set display name.

Parameters:

displayName - Method display name.

getDescription

public String getDescription()

Method description.

Returns:

Method description.

setDescription

public void setDescription(String description)

Set method description.

Parameters:

description - Description.

getQueryParameters

public Map<String,RamlParameter> getQueryParameters()

Map of query parameters.

Returns:

Query parameters.

setQueryParameters

public void setQueryParameters(Map<String,RamlParameter> queryParameters)

Set query parameters.

Parameters:

queryParameters - Query parameters.

getHeaders

public Map<String,RamlParameter> getHeaders()

Map of header parameters.

Returns:

Header parameters.

setHeaders

public void setHeaders(Map<String,RamlParameter> headers)

Set header parameters.

Parameters:

headers - Header parameters.

getResponses

public Map<Integer,RamlResponse> getResponses()

Map of status codes.

Returns:

Status Code.

setResponses

public void setResponses(Map<Integer,RamlResponse> responses)

Set status codes response.

Parameters:

responses - Response.

getMediaType

public List<String> getMediaType()

Request media types.

Returns:

Request media types.

setMediaType

public void setMediaType(List<String> mediaType)

Set media types.

Parameters:

mediaType - Media types.

getFormParameters

public Map<String,RamlParameter> getFormParameters()

Form parameters.

Returns:

Form parameters.

setFormParameters

public void setFormParameters(Map<String,RamlParameter> formParameters)

Set form parameters.

Parameters:

formParameters - Form parameters.

queryParameter

public RamlParameter queryParameter(String name)

Get or create a query parameter using the giving name.

Parameters:

name - Parameter name.

Returns:

Query parameter.

formParameter

public RamlParameter formParameter(String name)

Get or create a form parameter using the giving name.

Parameters:

name - Parameter name.

Returns:

Form parameter.

headerParameter

public RamlParameter headerParameter(String name)

Get or create a header parameter using the giving name.

Parameters:

name - Parameter name.

Returns:

Header parameter.

response

public RamlResponse response(Integer status)

Get or create a response using the given status code.

Parameters:

status - Status code.

Returns:

RAML response.