org.projectodd.jrapidoc.model.param

Class Param

java.lang.Object

org.projectodd.jrapidoc.model.param.Param

Direct Known Subclasses:

CookieParam, FormParam, HeaderParam, MatrixParam, PathParam, QueryParam

public abstract class Param
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Param.ParamBuilder
static class	Param.Type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Param(String name, Boolean isRequired, String typeRef, Param.Type type, String description)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
String	getName()
Param.Type	getType()
String	getTypeRef()
Boolean	isRequired()
void	setDescription(String description)
void	setName(String name)
void	setRequired(Boolean isRequired)
void	setType(Param.Type type)
void	setTypeRef(String typeRef)

Methods inherited from class java.lang.Object

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

Constructor Detail

Param

protected Param(String name,
     Boolean isRequired,
     String typeRef,
     Param.Type type,
     String description)

Method Detail

isRequired

public Boolean isRequired()

getTypeRef

public String getTypeRef()

getDescription

public String getDescription()

getName

public String getName()

getType

public Param.Type getType()

setName

public void setName(String name)

setRequired

public void setRequired(Boolean isRequired)

setType

public void setType(Param.Type type)

setDescription

public void setDescription(String description)

setTypeRef

public void setTypeRef(String typeRef)