com.jayway.restassured.config

Class ParamConfig

java.lang.Object

com.jayway.restassured.config.ParamConfig

All Implemented Interfaces:

Config

public class ParamConfig
extends Object
implements Config

Param config determines how different parameter types in REST Assured 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	ParamConfig.UpdateStrategy The update strategy to use for a parameter type

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamConfig

public ParamConfig()

Create a new instance where all parameters are merged

ParamConfig

public ParamConfig(ParamConfig.UpdateStrategy queryParamsUpdateStrategy,
                   ParamConfig.UpdateStrategy formParamsUpdateStrategy,
                   ParamConfig.UpdateStrategy requestParameterUpdateStrategy)

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 ParamConfig mergeAllParameters()

Merge all parameter types.

Returns:

A new instance of ParamConfig

replaceAllParameters

public ParamConfig replaceAllParameters()

Replace parameter values for all kinds of parameter types.

Returns:

A new instance of ParamConfig

formParamsUpdateStrategy

public ParamConfig formParamsUpdateStrategy(ParamConfig.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 ParamConfig

requestParamsUpdateStrategy

public ParamConfig requestParamsUpdateStrategy(ParamConfig.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 ParamConfig

queryParamsUpdateStrategy

public ParamConfig queryParamsUpdateStrategy(ParamConfig.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 ParamConfig

formParamsUpdateStrategy

public ParamConfig.UpdateStrategy formParamsUpdateStrategy()

Returns:

The update strategy for form parameters

requestParamsUpdateStrategy

public ParamConfig.UpdateStrategy requestParamsUpdateStrategy()

Returns:

The update strategy for request parameters

queryParamsUpdateStrategy

public ParamConfig.UpdateStrategy queryParamsUpdateStrategy()

Returns:

The update strategy for query parameters

isUserConfigured

public boolean isUserConfigured()

Specified by:

isUserConfigured in interface Config

Returns:

true if this config instance has been explicitly configured by the user, false if it has the default values.

paramConfig

public static ParamConfig paramConfig()

Returns:

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

and

public ParamConfig and()

Syntactic sugar.

Returns:

The same ParamConfig instance.

with

public ParamConfig with()

Syntactic sugar.

Returns:

The same ParamConfig instance.