org.springframework.restdocs.config

Class OperationPreprocessorsConfigurer<PARENT,TYPE>

java.lang.Object

org.springframework.restdocs.config.AbstractConfigurer

org.springframework.restdocs.config.AbstractNestedConfigurer<PARENT>

org.springframework.restdocs.config.OperationPreprocessorsConfigurer<PARENT,TYPE>

Type Parameters:

PARENT - the type of the configurer's parent

TYPE - the concrete type of the configurer to be returned from chained methods

Direct Known Subclasses:

MockMvcOperationPreprocessorsConfigurer, RestAssuredOperationPreprocessorsConfigurer, WebTestClientOperationPreprocessorsConfigurer

public abstract class OperationPreprocessorsConfigurer<PARENT,TYPE>
extends AbstractNestedConfigurer<PARENT>

A configurer that can be used to configure the default operation preprocessors.

Since:

2.0.0

Author:

Filip Hrisafov, Andy Wilkinson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OperationPreprocessorsConfigurer(PARENT parent) Creates a new OperationPreprocessorConfigurer with the given parent.

Method Summary

Modifier and Type	Method and Description
void	apply(java.util.Map<java.lang.String,java.lang.Object> configuration, RestDocumentationContext context) Applies the configurer to the given configuration.
TYPE	withRequestDefaults(OperationPreprocessor... preprocessors) Configures the default operation request preprocessors.
TYPE	withResponseDefaults(OperationPreprocessor... preprocessors) Configures the default operation response preprocessors.

Methods inherited from class org.springframework.restdocs.config.AbstractNestedConfigurer

and

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationPreprocessorsConfigurer

protected OperationPreprocessorsConfigurer(PARENT parent)

Creates a new OperationPreprocessorConfigurer with the given parent.

Parameters:

parent - the parent

Method Detail

apply

public void apply(java.util.Map<java.lang.String,java.lang.Object> configuration,
                  RestDocumentationContext context)

Description copied from class: AbstractConfigurer

Applies the configurer to the given configuration.

Specified by:

apply in class AbstractConfigurer

Parameters:

configuration - the configuration to be configured

context - the current documentation context

withRequestDefaults

public TYPE withRequestDefaults(OperationPreprocessor... preprocessors)

Configures the default operation request preprocessors.

Parameters:

preprocessors - the preprocessors

Returns:

this

withResponseDefaults

public TYPE withResponseDefaults(OperationPreprocessor... preprocessors)

Configures the default operation response preprocessors.

Parameters:

preprocessors - the preprocessors

Returns:

this