org.jsondoc.core.pojo

Class ApiObjectFieldDoc

java.lang.Object

org.jsondoc.core.pojo.AbstractDoc

org.jsondoc.core.pojo.ApiObjectFieldDoc

All Implemented Interfaces:

Comparable<ApiObjectFieldDoc>

public class ApiObjectFieldDoc
extends AbstractDoc
implements Comparable<ApiObjectFieldDoc>

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
ApiObjectFieldDoc()

Method Summary

Modifier and Type	Method and Description
static ApiObjectFieldDoc	buildFromAnnotation(ApiObjectField annotation, Field field)
int	compareTo(ApiObjectFieldDoc o) This comparison is the same as the one in ApiObjectFieldDoc class
boolean	equals(Object obj)
String[]	getAllowedvalues()
String	getDescription()
String	getFormat()
JSONDocType	getJsondocType()
String	getName()
Integer	getOrder()
String	getRequired()
ApiVersionDoc	getSupportedversions()
int	hashCode()
void	setAllowedvalues(String[] allowedvalues)
void	setDescription(String description)
void	setFormat(String format)
void	setJsondocType(JSONDocType jsondocType)
void	setName(String name)
void	setOrder(int order)
void	setRequired(String required)
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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

jsondocId

public final String jsondocId

Constructor Detail

ApiObjectFieldDoc

public ApiObjectFieldDoc()

Method Detail

buildFromAnnotation

public static ApiObjectFieldDoc buildFromAnnotation(ApiObjectField annotation,
                                                    Field field)

getAllowedvalues

public String[] getAllowedvalues()

setAllowedvalues

public void setAllowedvalues(String[] allowedvalues)

getFormat

public String getFormat()

setFormat

public void setFormat(String format)

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getRequired

public String getRequired()

setRequired

public void setRequired(String required)

getSupportedversions

public ApiVersionDoc getSupportedversions()

setSupportedversions

public void setSupportedversions(ApiVersionDoc supportedversions)

getJsondocType

public JSONDocType getJsondocType()

setJsondocType

public void setJsondocType(JSONDocType jsondocType)

setOrder

public void setOrder(int order)

getOrder

public Integer getOrder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(ApiObjectFieldDoc o)

This comparison is the same as the one in ApiObjectFieldDoc class

Specified by:

compareTo in interface Comparable<ApiObjectFieldDoc>