org.springframework.restdocs.operation.preprocess

Class Preprocessors

java.lang.Object

org.springframework.restdocs.operation.preprocess.Preprocessors

public class Preprocessors
extends Object

Static factory methods for creating OperationPreprocessors that can be applied to an Operation's request or response before it is documented.

Author:

Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
static OperationPreprocessor	maskLinks() Returns an OperationPreprocessor that will mask the href of hypermedia links in the request or response.
static OperationPreprocessor	maskLinks(String mask) Returns an OperationPreprocessor that will mask the href of hypermedia links in the request or response.
static OperationRequestPreprocessor	preprocessRequest(OperationPreprocessor... preprocessors) Returns an OperationRequestPreprocessor that will preprocess the request by applying the given preprocessors to it.
static OperationResponsePreprocessor	preprocessResponse(OperationPreprocessor... preprocessors) Returns an OperationResponsePreprocessor that will preprocess the response by applying the given preprocessors to it.
static OperationPreprocessor	prettyPrint() Returns an OperationPreprocessor that will pretty print the content of the request or response.
static OperationPreprocessor	removeHeaders(String... headersToRemove) Returns an OperationPreprocessor that will remove headers from the request or response.
static OperationPreprocessor	replacePattern(Pattern pattern, String replacement) Returns an OperationPreprocessor that will modify the content of the request or response by replacing occurences of the given pattern with the given replacement

Methods inherited from class java.lang.Object

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

Method Detail

preprocessRequest

public static OperationRequestPreprocessor preprocessRequest(OperationPreprocessor... preprocessors)

Returns an OperationRequestPreprocessor that will preprocess the request by applying the given preprocessors to it.

Parameters:

preprocessors - the preprocessors

Returns:

the request preprocessor

preprocessResponse

public static OperationResponsePreprocessor preprocessResponse(OperationPreprocessor... preprocessors)

Returns an OperationResponsePreprocessor that will preprocess the response by applying the given preprocessors to it.

Parameters:

preprocessors - the preprocessors

Returns:

the response preprocessor

prettyPrint

public static OperationPreprocessor prettyPrint()

Returns an OperationPreprocessor that will pretty print the content of the request or response.

Returns:

the preprocessor

removeHeaders

public static OperationPreprocessor removeHeaders(String... headersToRemove)

Returns an OperationPreprocessor that will remove headers from the request or response.

Parameters:

headersToRemove - the names of the headers to remove

Returns:

the preprocessor

maskLinks

public static OperationPreprocessor maskLinks()

Returns an OperationPreprocessor that will mask the href of hypermedia links in the request or response.

Returns:

the preprocessor

maskLinks

public static OperationPreprocessor maskLinks(String mask)

Returns an OperationPreprocessor that will mask the href of hypermedia links in the request or response.

Parameters:

mask - the link mask

Returns:

the preprocessor

replacePattern

public static OperationPreprocessor replacePattern(Pattern pattern,
                                                   String replacement)

Returns an OperationPreprocessor that will modify the content of the request or response by replacing occurences of the given pattern with the given replacement

Parameters:

pattern - the pattern

replacement - the replacement

Returns:

the preprocessor