org.restdoc.api

Class RestResource

java.lang.Object

org.restdoc.api.util.RestDocObject

org.restdoc.api.RestResource

public class RestResource
extends RestDocObject

Author:

hoegertn

Field Summary

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

additionalFields

Constructor Summary

Constructors

Constructor and Description
RestResource()

Method Summary

Methods

Modifier and Type	Method and Description
RestResource	description(String _description)
String	getDescription()
String	getId()
Map<String,MethodDefinition>	getMethods()
Map<String,ParamDefinition>	getParams()
String	getPath()
RestResource	id(String _id)
RestResource	method(String verb, MethodDefinition method)
RestResource	param(String _name, String _description, ParamValidation... _validations)
RestResource	path(String _path)
void	setDescription(String description)
void	setId(String id)
void	setPath(String path)

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

RestResource

public RestResource()

Method Detail

getId

public String getId()

Returns:

the id

setId

public void setId(String id)

Parameters:

id - the id to set

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

getPath

public String getPath()

Returns:

the path

setPath

public void setPath(String path)

Parameters:

path - the path to set

getParams

public Map<String,ParamDefinition> getParams()

Returns:

the params

getMethods

public Map<String,MethodDefinition> getMethods()

Returns:

the methods

id

public RestResource id(String _id)

Parameters:

_id -

Returns:

this

description

public RestResource description(String _description)

Parameters:

_description -

Returns:

this

path

public RestResource path(String _path)

Parameters:

_path -

Returns:

this

param

public RestResource param(String _name,
                 String _description,
                 ParamValidation... _validations)

Parameters:

_name -

_description -

_validations -

Returns:

this

method

public RestResource method(String verb,
                  MethodDefinition method)

Parameters:

verb -

method -

Returns:

this