com.apporiented.rest.apidoc.model

Class ApiMethodDocModel

java.lang.Object

com.apporiented.rest.apidoc.model.ApiMethodDocModel

All Implemented Interfaces:

Comparable<ApiMethodDocModel>

@ApiModelDoc(value="Model of a REST resource method documentation.")
public class ApiMethodDocModel
extends Object
implements Comparable<ApiMethodDocModel>

Model of a REST resource method documentation.

Author:

Lars Behnke

Constructor Summary

Constructors

Constructor and Description
ApiMethodDocModel()

Method Summary

Modifier and Type	Method and Description
int	compareTo(ApiMethodDocModel o)
String	getAction()
List<ApiErrorDocModel>	getApiErrors()
ApiDocModelRef	getBodyObject()
List<String>	getConsumes()
String	getDescription()
List<ApiHeaderDocModel>	getHeaders()
String	getHint()
String	getMethodName()
List<ApiParamDocModel>	getParameters()
String	getPath()
List<String>	getProduces()
ApiDocModelRef	getResponse()
void	setAction(String action)
void	setApiErrors(List<ApiErrorDocModel> apiErrors)
void	setBodyObject(ApiDocModelRef bodyObject)
void	setConsumes(List<String> consumes)
void	setDescription(String description)
void	setHeaders(List<ApiHeaderDocModel> headers)
void	setHint(String hint)
void	setMethodName(String name)
void	setParameters(List<ApiParamDocModel> parameters)
void	setPath(String path)
void	setProduces(List<String> produces)
void	setResponse(ApiDocModelRef response)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiMethodDocModel

public ApiMethodDocModel()

Method Detail

getHint

public String getHint()

setHint

public void setHint(String hint)

getHeaders

public List<ApiHeaderDocModel> getHeaders()

setHeaders

public void setHeaders(List<ApiHeaderDocModel> headers)

getProduces

public List<String> getProduces()

setProduces

public void setProduces(List<String> produces)

getConsumes

public List<String> getConsumes()

setConsumes

public void setConsumes(List<String> consumes)

getAction

public String getAction()

setAction

public void setAction(String action)

getPath

public String getPath()

setPath

public void setPath(String path)

getMethodName

public String getMethodName()

setMethodName

public void setMethodName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getParameters

public List<ApiParamDocModel> getParameters()

setParameters

public void setParameters(List<ApiParamDocModel> parameters)

getResponse

public ApiDocModelRef getResponse()

setResponse

public void setResponse(ApiDocModelRef response)

getBodyObject

public ApiDocModelRef getBodyObject()

setBodyObject

public void setBodyObject(ApiDocModelRef bodyObject)

getApiErrors

public List<ApiErrorDocModel> getApiErrors()

setApiErrors

public void setApiErrors(List<ApiErrorDocModel> apiErrors)

compareTo

public int compareTo(ApiMethodDocModel o)

Specified by:

compareTo in interface Comparable<ApiMethodDocModel>