org.restdoc.api

Class GlobalHeader

java.lang.Object

org.restdoc.api.util.RestDocObject

org.restdoc.api.GlobalHeader

public class GlobalHeader
extends RestDocObject

Author:

hoegertn

Field Summary

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

additionalFields

Constructor Summary

Constructors

Constructor and Description
GlobalHeader()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,HeaderDefinition>	getRequestHeader()
Map<String,HeaderDefinition>	getResponseHeader()
GlobalHeader	request(String _name, String _description, boolean _required)
GlobalHeader	response(String _name, String _description, boolean _required)

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

GlobalHeader

public GlobalHeader()

Method Detail

getRequestHeader

public Map<String,HeaderDefinition> getRequestHeader()

Returns:

the requestHeader

getResponseHeader

public Map<String,HeaderDefinition> getResponseHeader()

Returns:

the responseHeader

request

public GlobalHeader request(String _name,
                   String _description,
                   boolean _required)

Parameters:

_name -

_description -

_required -

Returns:

this

response

public GlobalHeader response(String _name,
                    String _description,
                    boolean _required)

Parameters:

_name -

_description -

_required -

Returns:

this