org.restdoc.api

Class RestDoc

java.lang.Object

org.restdoc.api.util.RestDocObject

org.restdoc.api.RestDoc

public class RestDoc
extends RestDocObject

Author:

hoegertn

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESTDOC_MEDIATYPE The RestDoc MediaType application/x-restdoc+json

Fields inherited from class org.restdoc.api.util.RestDocObject

additionalFields

Constructor Summary

Constructors

Constructor and Description
RestDoc()

Method Summary

Methods

Modifier and Type	Method and Description
GlobalHeader	getHeaders()
Collection<RestResource>	getResources()
HashMap<String,Schema>	getSchemas()
void	setHeaders(GlobalHeader headers)
void	setResources(Collection<RestResource> resources)
void	setSchemas(HashMap<String,Schema> schemas)

Methods inherited from class org.restdoc.api.util.RestDocObject

getAdditionalBoolean, getAdditionalField, getAdditionalFields, getAdditionalNumber, getAdditionalString, setAdditionalField

Methods inherited from class java.lang.Object

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

Field Detail

RESTDOC_MEDIATYPE

public static final String RESTDOC_MEDIATYPE

The RestDoc MediaType application/x-restdoc+json

See Also:

Constant Field Values

Constructor Detail

RestDoc

public RestDoc()

Method Detail

getHeaders

public GlobalHeader getHeaders()

Returns:

the headers

setHeaders

public void setHeaders(GlobalHeader headers)

Parameters:

headers - the headers to set

getResources

public Collection<RestResource> getResources()

Returns:

the resources

setResources

public void setResources(Collection<RestResource> resources)

Parameters:

resources - the resources to set

getSchemas

public HashMap<String,Schema> getSchemas()

Returns:

the schemas

setSchemas

public void setSchemas(HashMap<String,Schema> schemas)

Parameters:

schemas - the schemas to set