org.jsondoc.core.pojo

Class ApiObjectDoc

java.lang.Object

org.jsondoc.core.pojo.AbstractDoc

org.jsondoc.core.pojo.ApiObjectDoc

All Implemented Interfaces:

Comparable<ApiObjectDoc>

public class ApiObjectDoc
extends AbstractDoc
implements Comparable<ApiObjectDoc>

Field Summary

Fields

Modifier and Type	Field and Description
String	jsondocId

Fields inherited from class org.jsondoc.core.pojo.AbstractDoc

jsondocerrors, jsondochints, jsondocwarnings

Constructor Summary

Constructors

Constructor and Description
ApiObjectDoc()

Method Summary

Modifier and Type	Method and Description
static ApiObjectDoc	buildFromAnnotation(ApiObject annotation, Class clazz)
int	compareTo(ApiObjectDoc o)
String[]	getAllowedvalues()
String	getDescription()
Set<ApiObjectFieldDoc>	getFields()
String	getGroup()
JSONDocTemplate	getJsondocTemplate()
String	getName()
ApiVersionDoc	getSupportedversions()
void	setAllowedvalues(String[] allowedvalues)
void	setDescription(String description)
void	setFields(Set<ApiObjectFieldDoc> fields)
void	setGroup(String group)
void	setJsondocTemplate(JSONDocTemplate jsondocTemplate)
void	setName(String name)
void	setSupportedversions(ApiVersionDoc supportedversions)

Methods inherited from class org.jsondoc.core.pojo.AbstractDoc

addJsondocerror, addJsondochint, addJsondocwarning, getJsondocerrors, getJsondochints, getJsondocwarnings, setJsondocerrors, setJsondochints, setJsondocwarnings

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

ApiObjectDoc

public ApiObjectDoc()

Method Detail

buildFromAnnotation

public static ApiObjectDoc buildFromAnnotation(ApiObject annotation,
                                               Class clazz)

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getFields

public Set<ApiObjectFieldDoc> getFields()

setFields

public void setFields(Set<ApiObjectFieldDoc> fields)

getSupportedversions

public ApiVersionDoc getSupportedversions()

setSupportedversions

public void setSupportedversions(ApiVersionDoc supportedversions)

getAllowedvalues

public String[] getAllowedvalues()

setAllowedvalues

public void setAllowedvalues(String[] allowedvalues)

getGroup

public String getGroup()

setGroup

public void setGroup(String group)

getJsondocTemplate

public JSONDocTemplate getJsondocTemplate()

setJsondocTemplate

public void setJsondocTemplate(JSONDocTemplate jsondocTemplate)

compareTo

public int compareTo(ApiObjectDoc o)

Specified by:

compareTo in interface Comparable<ApiObjectDoc>