org.jsondoc.core.pojo

Class ApiDoc

java.lang.Object

org.jsondoc.core.pojo.ApiDoc

All Implemented Interfaces:

Comparable<ApiDoc>

public class ApiDoc
extends Object
implements Comparable<ApiDoc>

Field Summary

Fields

Modifier and Type	Field and Description
String	jsondocId

Constructor Summary

Constructors

Constructor and Description
ApiDoc()

Method Summary

Modifier and Type	Method and Description
void	addMethod(ApiMethodDoc apiMethod)
static ApiDoc	buildFromAnnotation(Api api)
int	compareTo(ApiDoc o)
ApiAuthDoc	getAuth()
String	getDescription()
String	getGroup()
Set<ApiMethodDoc>	getMethods()
String	getName()
ApiVersionDoc	getSupportedversions()
void	setAuth(ApiAuthDoc auth)
void	setDescription(String description)
void	setGroup(String group)
void	setMethods(Set<ApiMethodDoc> methods)
void	setName(String name)
void	setSupportedversions(ApiVersionDoc supportedversions)

Methods inherited from class java.lang.Object

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

Field Detail

jsondocId

public final String jsondocId

Constructor Detail

ApiDoc

public ApiDoc()

Method Detail

buildFromAnnotation

public static ApiDoc buildFromAnnotation(Api api)

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getMethods

public Set<ApiMethodDoc> getMethods()

setMethods

public void setMethods(Set<ApiMethodDoc> methods)

addMethod

public void addMethod(ApiMethodDoc apiMethod)

compareTo

public int compareTo(ApiDoc o)

Specified by:

compareTo in interface Comparable<ApiDoc>

getSupportedversions

public ApiVersionDoc getSupportedversions()

setSupportedversions

public void setSupportedversions(ApiVersionDoc supportedversions)

getAuth

public ApiAuthDoc getAuth()

setAuth

public void setAuth(ApiAuthDoc auth)

getGroup

public String getGroup()

setGroup

public void setGroup(String group)