br.com.anteros.restdoc.maven.plugin.doclet.model

Class Endpoint

java.lang.Object

br.com.anteros.restdoc.maven.plugin.doclet.model.Endpoint

public class Endpoint
extends Object

Classe utilizada para representar o endpoint do controller

Author:

Edson Martins, Eduardo Albertini

Constructor Summary

Constructors

Constructor and Description
Endpoint()
Endpoint(String path, String httpMethod, Collection<QueryParam> queryParams, Collection<PathVar> pathVars, RequestBody requestBody, Collection<String> consumes, Collection<String> produces, String shortDescription, String description, String type)

Method Summary

Modifier and Type	Method and Description
Collection<String>	getConsumes()
String	getDescription()
String	getHttpMethod()
String	getPath()
Collection<PathVar>	getPathVars()
Collection<String>	getProduces()
Collection<QueryParam>	getQueryParams()
RequestBody	getRequestBody()
String	getShortDescription()
String	getSimpleType()
String	getType()
void	setConsumes(Collection<String> consumes)
void	setDescription(String description)
void	setHttpMethod(String httpMethod)
void	setPath(String path)
void	setPathVars(Collection<PathVar> pathVars)
void	setProduces(Collection<String> produces)
void	setQueryParams(Collection<QueryParam> queryParams)
void	setRequestBody(RequestBody requestBody)
void	setShortDescription(String shortDescription)
void	setType(String type)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Endpoint

public Endpoint()

Endpoint

public Endpoint(String path,
                String httpMethod,
                Collection<QueryParam> queryParams,
                Collection<PathVar> pathVars,
                RequestBody requestBody,
                Collection<String> consumes,
                Collection<String> produces,
                String shortDescription,
                String description,
                String type)

Method Detail

getPath

public String getPath()

getHttpMethod

public String getHttpMethod()

getQueryParams

public Collection<QueryParam> getQueryParams()

getPathVars

public Collection<PathVar> getPathVars()

getRequestBody

public RequestBody getRequestBody()

getConsumes

public Collection<String> getConsumes()

getProduces

public Collection<String> getProduces()

getShortDescription

public String getShortDescription()

getDescription

public String getDescription()

getType

public String getType()

toString

public String toString()

Overrides:

toString in class Object

setPath

public void setPath(String path)

setHttpMethod

public void setHttpMethod(String httpMethod)

setQueryParams

public void setQueryParams(Collection<QueryParam> queryParams)

setPathVars

public void setPathVars(Collection<PathVar> pathVars)

setRequestBody

public void setRequestBody(RequestBody requestBody)

setConsumes

public void setConsumes(Collection<String> consumes)

setProduces

public void setProduces(Collection<String> produces)

setShortDescription

public void setShortDescription(String shortDescription)

setDescription

public void setDescription(String description)

setType

public void setType(String type)

getSimpleType

public String getSimpleType()