com.apporiented.rest.apidoc.model

Class ApiModelDocModel

java.lang.Object

com.apporiented.rest.apidoc.model.ApiModelDocModel

All Implemented Interfaces:

Comparable<ApiModelDocModel>

@ApiModelDoc(value="Documentation of a DTO (data transfer object).")
public class ApiModelDocModel
extends Object
implements Comparable<ApiModelDocModel>

Representation of the documentation of a model (domain) class.

Author:

Lars Behnke

Constructor Summary

Constructors

Constructor and Description
ApiModelDocModel()
ApiModelDocModel(String name, String description, List<ApiModelFieldDocModel> fields)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ApiModelDocModel o)
String	getClassName()
String	getDescription()
List<ApiModelFieldDocModel>	getFields()
String	getName()
void	setClassName(String className)
void	setDescription(String description)
void	setFields(List<ApiModelFieldDocModel> fields)
void	setName(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiModelDocModel

public ApiModelDocModel()

ApiModelDocModel

public ApiModelDocModel(String name,
                        String description,
                        List<ApiModelFieldDocModel> fields)

Method Detail

getClassName

public String getClassName()

setClassName

public void setClassName(String className)

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getFields

public List<ApiModelFieldDocModel> getFields()

setFields

public void setFields(List<ApiModelFieldDocModel> fields)

compareTo

public int compareTo(ApiModelDocModel o)

Specified by:

compareTo in interface Comparable<ApiModelDocModel>