org.jsondoc.core.pojo

Class ApiMethodDoc

java.lang.Object

org.jsondoc.core.pojo.AbstractDoc

org.jsondoc.core.pojo.ApiMethodDoc

All Implemented Interfaces:

Comparable<ApiMethodDoc>

public class ApiMethodDoc
extends AbstractDoc
implements Comparable<ApiMethodDoc>

Field Summary

Fields

Modifier and Type	Field and Description
String	jsondocId

Fields inherited from class org.jsondoc.core.pojo.AbstractDoc

jsondocerrors, jsondochints, jsondocwarnings

Constructor Summary

Constructors

Constructor and Description
ApiMethodDoc()

Method Summary

Modifier and Type	Method and Description
static ApiMethodDoc	buildFromAnnotation(ApiMethod annotation)
int	compareTo(ApiMethodDoc o)
List<ApiErrorDoc>	getApierrors()
ApiAuthDoc	getAuth()
ApiBodyObjectDoc	getBodyobject()
Set<String>	getConsumes()
String	getDescription()
String	getDisplayedMethodString()
JSONDoc.MethodDisplay	getDisplayMethodAs()
Set<ApiHeaderDoc>	getHeaders()
String	getId()
String	getPath()
Set<ApiParamDoc>	getPathparameters()
Set<String>	getProduces()
Set<ApiParamDoc>	getQueryparameters()
ApiResponseObjectDoc	getResponse()
String	getResponsestatuscode()
String	getSummary()
ApiVersionDoc	getSupportedversions()
ApiVerb	getVerb()
void	setApierrors(List<ApiErrorDoc> apierrors)
void	setAuth(ApiAuthDoc auth)
void	setBodyobject(ApiBodyObjectDoc bodyobject)
void	setConsumes(Set<String> consumes)
void	setDescription(String description)
void	setDisplayMethodAs(JSONDoc.MethodDisplay displayMethodAs)
void	setHeaders(Set<ApiHeaderDoc> headers)
void	setId(String id)
void	setPath(String path)
void	setPathparameters(Set<ApiParamDoc> pathparameters)
void	setProduces(Set<String> produces)
void	setQueryparameters(Set<ApiParamDoc> queryparameters)
void	setResponse(ApiResponseObjectDoc response)
void	setResponsestatuscode(String responsestatuscode)
void	setSummary(String summary)
void	setSupportedversions(ApiVersionDoc supportedversions)
void	setVerb(ApiVerb verb)

Methods inherited from class org.jsondoc.core.pojo.AbstractDoc

addJsondocerror, addJsondochint, addJsondocwarning, getJsondocerrors, getJsondochints, getJsondocwarnings, setJsondocerrors, setJsondochints, setJsondocwarnings

Methods inherited from class java.lang.Object

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

Field Detail

jsondocId

public final String jsondocId

Constructor Detail

ApiMethodDoc

public ApiMethodDoc()

Method Detail

buildFromAnnotation

public static ApiMethodDoc buildFromAnnotation(ApiMethod annotation)

getHeaders

public Set<ApiHeaderDoc> getHeaders()

setHeaders

public void setHeaders(Set<ApiHeaderDoc> headers)

getProduces

public Set<String> getProduces()

setProduces

public void setProduces(Set<String> produces)

getConsumes

public Set<String> getConsumes()

setConsumes

public void setConsumes(Set<String> consumes)

getVerb

public ApiVerb getVerb()

setVerb

public void setVerb(ApiVerb verb)

getPath

public String getPath()

setPath

public void setPath(String path)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getPathparameters

public Set<ApiParamDoc> getPathparameters()

setPathparameters

public void setPathparameters(Set<ApiParamDoc> pathparameters)

getQueryparameters

public Set<ApiParamDoc> getQueryparameters()

setQueryparameters

public void setQueryparameters(Set<ApiParamDoc> queryparameters)

getResponse

public ApiResponseObjectDoc getResponse()

setResponse

public void setResponse(ApiResponseObjectDoc response)

getBodyobject

public ApiBodyObjectDoc getBodyobject()

setBodyobject

public void setBodyobject(ApiBodyObjectDoc bodyobject)

getApierrors

public List<ApiErrorDoc> getApierrors()

setApierrors

public void setApierrors(List<ApiErrorDoc> apierrors)

getSupportedversions

public ApiVersionDoc getSupportedversions()

setSupportedversions

public void setSupportedversions(ApiVersionDoc supportedversions)

getAuth

public ApiAuthDoc getAuth()

setAuth

public void setAuth(ApiAuthDoc auth)

getResponsestatuscode

public String getResponsestatuscode()

setResponsestatuscode

public void setResponsestatuscode(String responsestatuscode)

getId

public String getId()

setId

public void setId(String id)

getSummary

public String getSummary()

setSummary

public void setSummary(String summary)

getDisplayMethodAs

public JSONDoc.MethodDisplay getDisplayMethodAs()

setDisplayMethodAs

public void setDisplayMethodAs(JSONDoc.MethodDisplay displayMethodAs)

getDisplayedMethodString

public String getDisplayedMethodString()

compareTo

public int compareTo(ApiMethodDoc o)

Specified by:

compareTo in interface Comparable<ApiMethodDoc>