org.springframework.restdocs.operation.preprocess

Class ParametersModifyingOperationPreprocessor

java.lang.Object

org.springframework.restdocs.operation.preprocess.OperationPreprocessorAdapter

org.springframework.restdocs.operation.preprocess.ParametersModifyingOperationPreprocessor

All Implemented Interfaces:

OperationPreprocessor

public final class ParametersModifyingOperationPreprocessor
extends OperationPreprocessorAdapter

An OperationPreprocessor that can be used to modify a request's OperationRequest.getParameters() by adding, setting, and removing parameters.

Since:

1.1.0

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
ParametersModifyingOperationPreprocessor()

Method Summary

Modifier and Type	Method and Description
ParametersModifyingOperationPreprocessor	add(java.lang.String name, java.lang.String value) Adds a parameter with the given name and value.
OperationRequest	preprocess(OperationRequest request) Returns the given request as-is.
ParametersModifyingOperationPreprocessor	remove(java.lang.String name) Removes the parameter with the given name.
ParametersModifyingOperationPreprocessor	remove(java.lang.String name, java.lang.String value) Removes the given value from the parameter with the given name.
ParametersModifyingOperationPreprocessor	set(java.lang.String name, java.lang.String... values) Sets the parameter with the given name to have the given values.

Methods inherited from class org.springframework.restdocs.operation.preprocess.OperationPreprocessorAdapter

preprocess

Methods inherited from class java.lang.Object

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

Constructor Detail

ParametersModifyingOperationPreprocessor

public ParametersModifyingOperationPreprocessor()

Method Detail

preprocess

public OperationRequest preprocess(OperationRequest request)

Description copied from class: OperationPreprocessorAdapter

Returns the given request as-is.

Specified by:

preprocess in interface OperationPreprocessor

Overrides:

preprocess in class OperationPreprocessorAdapter

Parameters:

request - the request

Returns:

the unmodified request

add

public ParametersModifyingOperationPreprocessor add(java.lang.String name,
                                                    java.lang.String value)

Adds a parameter with the given name and value.

Parameters:

name - the name

value - the value

Returns:

this

set

public ParametersModifyingOperationPreprocessor set(java.lang.String name,
                                                    java.lang.String... values)

Sets the parameter with the given name to have the given values.

Parameters:

name - the name

values - the values

Returns:

this

remove

public ParametersModifyingOperationPreprocessor remove(java.lang.String name)

Removes the parameter with the given name.

Parameters:

name - the name of the parameter

Returns:

this

remove

public ParametersModifyingOperationPreprocessor remove(java.lang.String name,
                                                       java.lang.String value)

Removes the given value from the parameter with the given name.

Parameters:

name - the name

value - the value

Returns:

this