org.restdoc.api

Class MethodDefinition

java.lang.Object

org.restdoc.api.util.RestDocObject

org.restdoc.api.MethodDefinition

public class MethodDefinition
extends RestDocObject

Author:

hoegertn

Field Summary

Fields inherited from class org.restdoc.api.util.RestDocObject

additionalFields

Constructor Summary

Constructors

Constructor and Description
MethodDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
MethodDefinition	accept(String _type, String _schema)
MethodDefinition	description(String _description)
MethodDefinition	example(ExampleRequest _exampleRequest)
Collection<Representation>	getAccepts()
String	getDescription()
Collection<ExampleRequest>	getExamples()
Map<String,HeaderDefinition>	getHeaders()
ResponseDefinition	getResponse()
Map<String,String>	getStatusCodes()
MethodDefinition	header(String _name, String _description, boolean _required)
MethodDefinition	response(ResponseDefinition _response)
void	setDescription(String description)
void	setResponse(ResponseDefinition response)
MethodDefinition	statusCode(String _code, String _description)

Methods inherited from class org.restdoc.api.util.RestDocObject

getAdditionalBoolean, getAdditionalField, getAdditionalFields, getAdditionalNumber, getAdditionalString, setAdditionalField

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodDefinition

public MethodDefinition()

Method Detail

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

getStatusCodes

public Map<String,String> getStatusCodes()

Returns:

the statusCodes

getResponse

public ResponseDefinition getResponse()

Returns:

the response

setResponse

public void setResponse(ResponseDefinition response)

Parameters:

response - the response to set

getAccepts

public Collection<Representation> getAccepts()

Returns:

the accepts

getHeaders

public Map<String,HeaderDefinition> getHeaders()

Returns:

the headers

getExamples

public Collection<ExampleRequest> getExamples()

Returns:

the examples

description

public MethodDefinition description(String _description)

Parameters:

_description -

Returns:

this

statusCode

public MethodDefinition statusCode(String _code,
                          String _description)

Parameters:

_code -

_description -

Returns:

this

accept

public MethodDefinition accept(String _type,
                      String _schema)

Parameters:

_type -

_schema -

Returns:

this

header

public MethodDefinition header(String _name,
                      String _description,
                      boolean _required)

Parameters:

_name -

_description -

_required -

Returns:

this

response

public MethodDefinition response(ResponseDefinition _response)

Parameters:

_response -

Returns:

this

example

public MethodDefinition example(ExampleRequest _exampleRequest)

Parameters:

_exampleRequest -

Returns:

this