org.restdoc.api

Class ExampleRequest

java.lang.Object

org.restdoc.api.util.RestDocObject

org.restdoc.api.ExampleRequest

public class ExampleRequest
extends RestDocObject

Author:

hoegertn

Field Summary

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

additionalFields

Constructor Summary

Constructors

Constructor and Description
ExampleRequest()
ExampleRequest(String path, String body)

Method Summary

Methods

Modifier and Type	Method and Description
String	getBody()
Map<String,String>	getHeaders()
String	getPath()
ExampleRequest	header(String _header, String _value)
void	setBody(String body)
void	setPath(String path)

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

ExampleRequest

public ExampleRequest()

ExampleRequest

public ExampleRequest(String path,
              String body)

Parameters:

path -

body -

Method Detail

getPath

public String getPath()

Returns:

the path

setPath

public void setPath(String path)

Parameters:

path - the path to set

getBody

public String getBody()

Returns:

the body

setBody

public void setBody(String body)

Parameters:

body - the body to set

getHeaders

public Map<String,String> getHeaders()

Returns:

the headers

header

public ExampleRequest header(String _header,
                    String _value)

Parameters:

_header -

_value -

Returns:

this