org.springframework.restdocs.operation

Class OperationResponseFactory

java.lang.Object

org.springframework.restdocs.operation.OperationResponseFactory

public class OperationResponseFactory
extends Object

A factory for creating OperationResponses.

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
OperationResponseFactory()

Method Summary

Modifier and Type	Method and Description
OperationResponse	create(HttpStatus status, HttpHeaders headers, byte[] content) Creates a new OperationResponse.
OperationResponse	createFrom(OperationResponse original, byte[] newContent) Creates a new OperationResponse based on the given original but with the given newContent.
OperationResponse	createFrom(OperationResponse original, HttpHeaders newHeaders) Creates a new OperationResponse based on the given original but with the given newHeaders.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationResponseFactory

public OperationResponseFactory()

Method Detail

create

public OperationResponse create(HttpStatus status,
                                HttpHeaders headers,
                                byte[] content)

Creates a new OperationResponse. If the response has any content, the given headers will be augmented to ensure that they include a Content-Length header.

Parameters:

status - the status of the response

headers - the request's headers

content - the content of the request

Returns:

the OperationResponse

createFrom

public OperationResponse createFrom(OperationResponse original,
                                    byte[] newContent)

Creates a new OperationResponse based on the given original but with the given newContent. If the original response had a Content-Length header it will be modified to match the length of the new content.

Parameters:

original - The original response

newContent - The new content

Returns:

The new response with the new content

createFrom

public OperationResponse createFrom(OperationResponse original,
                                    HttpHeaders newHeaders)

Creates a new OperationResponse based on the given original but with the given newHeaders.

Parameters:

original - The original response

newHeaders - The new headers

Returns:

The new response with the new headers