com.jayway.restassured.module.mockmvc.config

Class MockMvcParamConfig

java.lang.Object

com.jayway.restassured.module.mockmvc.config.MockMvcParamConfig

All Implemented Interfaces:

Config

public class MockMvcParamConfig
extends Object
implements Config

Determines how different parameter types in REST Assured MockMvc should be updated when adding multiple parameters of the same type with the same name.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MockMvcParamConfig.UpdateStrategy The update strategy to use for a parameter type

Constructor Summary

Constructors

Constructor and Description
MockMvcParamConfig() Create a new instance where all parameters are merged
MockMvcParamConfig(MockMvcParamConfig.UpdateStrategy queryParamsUpdateStrategy, MockMvcParamConfig.UpdateStrategy formParamsUpdateStrategy, MockMvcParamConfig.UpdateStrategy requestParameterUpdateStrategy, MockMvcParamConfig.UpdateStrategy attributeUpdateStrategy) Create a new instance and specify update strategies for all parameter types.

Method Summary

Modifier and Type	Method and Description
MockMvcParamConfig	and() Syntactic sugar.
MockMvcParamConfig.UpdateStrategy	attributeUpdateStrategy()
MockMvcParamConfig	attributeUpdateStrategy(MockMvcParamConfig.UpdateStrategy updateStrategy) Set attribute update strategy to the given value.
MockMvcParamConfig.UpdateStrategy	formParamsUpdateStrategy()
MockMvcParamConfig	formParamsUpdateStrategy(MockMvcParamConfig.UpdateStrategy updateStrategy) Set form parameter update strategy to the given value.
boolean	isUserConfigured()
MockMvcParamConfig	mergeAllParameters() Merge all parameter types.
static MockMvcParamConfig	paramConfig()
MockMvcParamConfig.UpdateStrategy	queryParamsUpdateStrategy()
MockMvcParamConfig	queryParamsUpdateStrategy(MockMvcParamConfig.UpdateStrategy updateStrategy) Set query parameter update strategy to the given value.
MockMvcParamConfig	replaceAllParameters() Replace parameter values for all kinds of parameter types.
MockMvcParamConfig.UpdateStrategy	requestParamsUpdateStrategy()
MockMvcParamConfig	requestParamsUpdateStrategy(MockMvcParamConfig.UpdateStrategy updateStrategy) Set request parameter update strategy to the given value.
MockMvcParamConfig	with() Syntactic sugar.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockMvcParamConfig

public MockMvcParamConfig()

Create a new instance where all parameters are merged

MockMvcParamConfig

public MockMvcParamConfig(MockMvcParamConfig.UpdateStrategy queryParamsUpdateStrategy,
                          MockMvcParamConfig.UpdateStrategy formParamsUpdateStrategy,
                          MockMvcParamConfig.UpdateStrategy requestParameterUpdateStrategy,
                          MockMvcParamConfig.UpdateStrategy attributeUpdateStrategy)

Create a new instance and specify update strategies for all parameter types.

Parameters:

queryParamsUpdateStrategy - The update strategy for query parameters

formParamsUpdateStrategy - The update strategy for form parameters

requestParameterUpdateStrategy - The update strategy for request parameters

Method Detail

mergeAllParameters

public MockMvcParamConfig mergeAllParameters()

Merge all parameter types.

Returns:

A new instance of MockMvcParamConfig

replaceAllParameters

public MockMvcParamConfig replaceAllParameters()

Replace parameter values for all kinds of parameter types.

Returns:

A new instance of MockMvcParamConfig

formParamsUpdateStrategy

public MockMvcParamConfig formParamsUpdateStrategy(MockMvcParamConfig.UpdateStrategy updateStrategy)

Set form parameter update strategy to the given value.

Parameters:

updateStrategy - The update strategy to use for form parameters

Returns:

A new instance of MockMvcParamConfig

requestParamsUpdateStrategy

public MockMvcParamConfig requestParamsUpdateStrategy(MockMvcParamConfig.UpdateStrategy updateStrategy)

Set request parameter update strategy to the given value. A "request parameter" is a parameter that will turn into a form or query parameter depending on the request. For example:

given().param("name", "value").when().get("/x"). ..

Parameters:

updateStrategy - The update strategy to use for request parameters

Returns:

A new instance of MockMvcParamConfig

queryParamsUpdateStrategy

public MockMvcParamConfig queryParamsUpdateStrategy(MockMvcParamConfig.UpdateStrategy updateStrategy)

Set query parameter update strategy to the given value.

Parameters:

updateStrategy - The update strategy to use for query parameters

Returns:

A new instance of MockMvcParamConfig

attributeUpdateStrategy

public MockMvcParamConfig attributeUpdateStrategy(MockMvcParamConfig.UpdateStrategy updateStrategy)

Set attribute update strategy to the given value.

Parameters:

updateStrategy - The update strategy to use for query parameters

Returns:

A new instance of MockMvcParamConfig

attributeUpdateStrategy

public MockMvcParamConfig.UpdateStrategy attributeUpdateStrategy()

Returns:

The update strategy for form parameters

formParamsUpdateStrategy

public MockMvcParamConfig.UpdateStrategy formParamsUpdateStrategy()

Returns:

The update strategy for form parameters

requestParamsUpdateStrategy

public MockMvcParamConfig.UpdateStrategy requestParamsUpdateStrategy()

Returns:

The update strategy for request parameters

queryParamsUpdateStrategy

public MockMvcParamConfig.UpdateStrategy queryParamsUpdateStrategy()

Returns:

The update strategy for query parameters

isUserConfigured

public boolean isUserConfigured()

Specified by:

isUserConfigured in interface Config

paramConfig

public static MockMvcParamConfig paramConfig()

Returns:

A static way to create a new MockMvcParamConfig instance without calling "new" explicitly. Mainly for syntactic sugar.

and

public MockMvcParamConfig and()

Syntactic sugar.

Returns:

The same MockMvcParamConfig instance.

with

public MockMvcParamConfig with()

Syntactic sugar.

Returns:

The same MockMvcParamConfig instance.