junitparams

Annotation Type Parameters

@Retention(value=RUNTIME)
public @interface Parameters

THE annotation for the test parameters. Use it to say that a method takes some parameters and define how to obtain them.

Author:

Pawel Lipinski

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	method Parameter values returned by a method within the test class.
String	named Alternative way to designate a method providing parameters for test.
Class<?>	source Parameter values defined externally.
String[]	value Parameter values defined as a String array.

Element Detail

value

public abstract String[] value

Parameter values defined as a String array. Each element in the array is a full parameter set, comma-separated or pipe-separated ('|'). The values must match the method parameters in order and type. Whitespace characters are trimmed (use source class or method if You need to provide such parameters)

Example: @Parameters({ "1, joe, 26.4, true", "2, angie, 37.2, false"})

Default:

{}

source

public abstract Class<?> source

Parameter values defined externally. The specified class must have at least one public static method starting with provide returning Object[]. All such methods are used, so you can group your examples. The resulting array should contain parameter sets in its elements. Each parameter set must be another Object[] array, which contains parameter values in its elements. Example: @Parameters(source = PeopleProvider.class)

Default:

junitparams.NullType.class

method

public abstract String method

Parameter values returned by a method within the test class. This way you don't need additional classes and the test code may be a bit cleaner. The format of the data returned by the method is the same as for the source annotation class. Example: @Parameters(method = "exemplaryPeople")

You can use multiple methods to provide parameters - use comma to do it: Example: @Parameters(method = "womenParams, menParams")

Default:

""

named

public abstract String named

Alternative way to designate a method providing parameters for test. Annotate provider method with @NamedParameters. This way you can rely on method description instead of name.

Example:
@Parameters(named = "exemplaryPeople")
You can use multiple named methods to provide parameters - use comma to do it:
@Parameters(named = "womenParams, menParams")

See Also:

NamedParameters

Default:

""