org.restdoc.api

Class ParamDefinition

java.lang.Object

org.restdoc.api.util.RestDocObject

org.restdoc.api.ParamDefinition

public class ParamDefinition
extends RestDocObject

Author:

hoegertn

Field Summary

Fields inherited from class org.restdoc.api.util.RestDocObject

additionalFields

Constructor Summary

Constructors

Constructor and Description
ParamDefinition()
ParamDefinition(String description)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
Collection<ParamValidation>	getValidations()
void	setDescription(String description)

Methods inherited from class org.restdoc.api.util.RestDocObject

getAdditionalBoolean, getAdditionalField, getAdditionalFields, getAdditionalNumber, getAdditionalString, setAdditionalField

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamDefinition

public ParamDefinition()

ParamDefinition

public ParamDefinition(String description)

Parameters:

description -

Method Detail

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

getValidations

public Collection<ParamValidation> getValidations()

Returns:

the validations