com.apporiented.rest.apidoc.model

Class ApiParamDocModel

java.lang.Object

com.apporiented.rest.apidoc.model.ApiParamDocModel

@ApiModelDoc(value="Documentation of a parameter of a REST resource method.")
public class ApiParamDocModel
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiParamDocModel()
ApiParamDocModel(String name, String description, ApiParamType paramType, boolean required, String dataType, String[] allowedValues, String format)

Method Summary

Modifier and Type	Method and Description
String[]	getAllowedValues()
String	getDataType()
String	getDescription()
String	getFormat()
String	getModelRef()
String	getName()
ApiParamType	getParamType()
boolean	getRequired()
void	setAllowedValues(String[] allowedValues)
void	setDataType(String dataType)
void	setDescription(String description)
void	setFormat(String format)
void	setModelRef(String modelRef)
void	setName(String name)
void	setParamType(ApiParamType paramType)
void	setRequired(Boolean required)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiParamDocModel

public ApiParamDocModel()

ApiParamDocModel

public ApiParamDocModel(String name,
                        String description,
                        ApiParamType paramType,
                        boolean required,
                        String dataType,
                        String[] allowedValues,
                        String format)

Method Detail

getParamType

public ApiParamType getParamType()

setParamType

public void setParamType(ApiParamType paramType)

getModelRef

public String getModelRef()

setModelRef

public void setModelRef(String modelRef)

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getRequired

public boolean getRequired()

setRequired

public void setRequired(Boolean required)

getAllowedValues

public String[] getAllowedValues()

setAllowedValues

public void setAllowedValues(String[] allowedValues)

getFormat

public String getFormat()

setFormat

public void setFormat(String format)

getDataType

public String getDataType()

setDataType

public void setDataType(String dataType)