org.restdoc.api

Class ResponseDefinition

java.lang.Object

org.restdoc.api.util.RestDocObject

org.restdoc.api.ResponseDefinition

public class ResponseDefinition
extends RestDocObject

Author:

hoegertn

Field Summary

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

additionalFields

Constructor Summary

Constructors

Constructor and Description
ResponseDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,HeaderDefinition>	getHeaders()
Collection<Representation>	getTypes()
ResponseDefinition	header(String _name, String _description, boolean _required)
ResponseDefinition	type(String _type, String _schema)

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

Constructor Detail

ResponseDefinition

public ResponseDefinition()

Method Detail

getTypes

public Collection<Representation> getTypes()

Returns:

the types

getHeaders

public Map<String,HeaderDefinition> getHeaders()

Returns:

the headers

type

public ResponseDefinition type(String _type,
                      String _schema)

Parameters:

_type -

_schema -

Returns:

this

header

public ResponseDefinition header(String _name,
                        String _description,
                        boolean _required)

Parameters:

_name -

_description -

_required -

Returns:

this