com.tngtech.java.junit.dataprovider

Class DataProviders

java.lang.Object

com.tngtech.java.junit.dataprovider.DataProviders

public class DataProviders
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DataProviders()

Method Summary

Modifier and Type	Method and Description
static java.lang.Object[]	$(java.lang.Object... args) Helper method to create an Object array containing all the given arguments, e.g.
static java.lang.Object[][]	$$(java.lang.Object[]... args) Helper method to create an array of the given Object arrays, e.g.
static java.lang.Object[][]	crossProduct(java.lang.Object[][] rows1, java.lang.Object[][] rows2) Creates a dataprovider test for each combination of elements of the two provided data providers.
static <E extends java.lang.Enum<E>> java.lang.Object[][]	testForEach(java.lang.Class<E> enumClass) Creates a dataprovider test for each value in the given Enum class.
static <T> java.lang.Object[][]	testForEach(java.lang.Iterable<T> args) Deprecated. since 1.12.0 Iterable<?> can directly be returned from any dataprovider method
static java.lang.Object[][]	testForEach(java.lang.Object... args) Creates a dataprovider test for each argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataProviders

public DataProviders()

Method Detail

$

public static java.lang.Object[] $(java.lang.Object... args)

Helper method to create an Object array containing all the given arguments, e.g.

 
 Object[] a = $("test", 4);
 
 

Parameters:

args - which should be contained in the resulting Object array

Returns:

an Object array containing all the given args

See Also:

$$(java.lang.Object[]...)

$$

public static java.lang.Object[][] $$(java.lang.Object[]... args)

Helper method to create an array of the given Object arrays, e.g.

 
 // @formatter:off
 Object[][] b = $$(
          $("",        0),
          $("test",    4),
          $("foo bar", 7),
      );
 // @formatter:on
 
 

Parameters:

args - which should be contained in the resulting array of Object array

Returns:

an array of Object arrays containing all the given args

See Also:

$(java.lang.Object...)

testForEach

public static java.lang.Object[][] testForEach(java.lang.Object... args)

Creates a dataprovider test for each argument.

Parameters:

args - which are wrapped in Object arrays and combined to Object[][]

Returns:

an array which contains Object arrays for each single argument

testForEach

@Deprecated
public static <T> java.lang.Object[][] testForEach(java.lang.Iterable<T> args)

Deprecated. since 1.12.0 Iterable<?> can directly be returned from any dataprovider method

Creates a dataprovider test for each element in the given Iterable.

Type Parameters:

T - the type of elements returned by the given Iterable

Parameters:

args - which are wrapped in Object arrays and combined to Object[][]

Returns:

an array which contains Object arrays for each single element in the given Iterable

Throws:

java.lang.NullPointerException - iif given args is null

testForEach

public static <E extends java.lang.Enum<E>> java.lang.Object[][] testForEach(java.lang.Class<E> enumClass)

Creates a dataprovider test for each value in the given Enum class.

Type Parameters:

E - the type of the enum type subclass modeled by the given Class

Parameters:

enumClass - for which each value is wrapped into an array of Object arrays

Returns:

an array which contains Object arrays for each single value in the given Enum

Throws:

java.lang.NullPointerException - iif given enumClass is null

crossProduct

public static java.lang.Object[][] crossProduct(java.lang.Object[][] rows1,
                                                java.lang.Object[][] rows2)

Creates a dataprovider test for each combination of elements of the two provided data providers.

 
 Object[][] r = crossProduct(dataProviderMethod1, dataProviderMethod2);
 
 

Parameters:

rows1 - of first dataprovider which should be cross producted with the second

rows2 - of second dataprovider which should be cross producted with the first

Returns:

an Object array array containing the cross product of the given rows