org.springframework.restdocs.response

Class ContentModifyingReponsePostProcessor

java.lang.Object

org.springframework.restdocs.response.ContentModifyingReponsePostProcessor

All Implemented Interfaces:

ResponsePostProcessor

public abstract class ContentModifyingReponsePostProcessor
extends Object
implements ResponsePostProcessor

A base class for ResponsePostProcessors that modify the content of the response.

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
ContentModifyingReponsePostProcessor()

Method Summary

Modifier and Type	Method and Description
protected abstract String	modifyContent(String originalContent) Returns a modified version of the given originalContent
MockHttpServletResponse	postProcess(MockHttpServletResponse response) Post-processes the given response, returning a, possibly new, MockHttpServletResponse that should now be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentModifyingReponsePostProcessor

public ContentModifyingReponsePostProcessor()

Method Detail

postProcess

public MockHttpServletResponse postProcess(MockHttpServletResponse response)
                                    throws Exception

Description copied from interface: ResponsePostProcessor

Post-processes the given response, returning a, possibly new, MockHttpServletResponse that should now be used.

Specified by:

postProcess in interface ResponsePostProcessor

Parameters:

response - The response to post-process

Returns:

The result of the post-processing

Throws:

Exception - if a failure occurs during the post-processing

modifyContent

protected abstract String modifyContent(String originalContent)
                                 throws Exception

Returns a modified version of the given originalContent

Parameters:

originalContent - the content to modify

Returns:

the modified content

Throws:

Exception - if a failure occurs while modifying the content