org.jsondoc.core.pojo

Class ApiParamDoc

java.lang.Object

org.jsondoc.core.pojo.AbstractDoc

org.jsondoc.core.pojo.ApiParamDoc

All Implemented Interfaces:

Comparable<ApiParamDoc>

public class ApiParamDoc
extends AbstractDoc
implements Comparable<ApiParamDoc>

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
ApiParamDoc(String name, String description, JSONDocType jsondocType, String required, String[] allowedvalues, String format, String defaultvalue)

Method Summary

Modifier and Type	Method and Description
static ApiParamDoc	buildFromAnnotation(ApiPathParam annotation, JSONDocType jsondocType, ApiParamType paramType)
static ApiParamDoc	buildFromAnnotation(ApiQueryParam annotation, JSONDocType jsondocType, ApiParamType paramType)
int	compareTo(ApiParamDoc o)
boolean	equals(Object obj)
String[]	getAllowedvalues()
String	getDefaultvalue()
String	getDescription()
String	getFormat()
JSONDocType	getJsondocType()
String	getName()
String	getRequired()
int	hashCode()
void	setAllowedvalues(String[] allowedvalues)
void	setDefaultvalue(String defaultvalue)
void	setDescription(String description)
void	setFormat(String format)
void	setName(String name)
void	setRequired(String required)

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

jsondocId

public final String jsondocId

Constructor Detail

ApiParamDoc

public ApiParamDoc(String name,
                   String description,
                   JSONDocType jsondocType,
                   String required,
                   String[] allowedvalues,
                   String format,
                   String defaultvalue)

Method Detail

buildFromAnnotation

public static ApiParamDoc buildFromAnnotation(ApiPathParam annotation,
                                              JSONDocType jsondocType,
                                              ApiParamType paramType)

buildFromAnnotation

public static ApiParamDoc buildFromAnnotation(ApiQueryParam annotation,
                                              JSONDocType jsondocType,
                                              ApiParamType paramType)

getJsondocType

public JSONDocType getJsondocType()

getName

public String getName()

getDescription

public String getDescription()

getRequired

public String getRequired()

getAllowedvalues

public String[] getAllowedvalues()

getFormat

public String getFormat()

setName

public void setName(String name)

setDescription

public void setDescription(String description)

setRequired

public void setRequired(String required)

setAllowedvalues

public void setAllowedvalues(String[] allowedvalues)

setFormat

public void setFormat(String format)

getDefaultvalue

public String getDefaultvalue()

setDefaultvalue

public void setDefaultvalue(String defaultvalue)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(ApiParamDoc o)

Specified by:

compareTo in interface Comparable<ApiParamDoc>