com.tngtech.java.junit.dataprovider.DataProviders Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of junit4-dataprovider Show documentation
A TestNG like dataprovider runner for JUnit having a simplified syntax compared to all the existing JUnit4 features.
There is a newer version: 2.10
package com.tngtech.java.junit.dataprovider;

import static com.tngtech.java.junit.dataprovider.common.Preconditions.checkNotNull;

import java.util.ArrayList;
import java.util.List;

public class DataProviders {

    /**
     * Helper method to create an {@link Object} array containing all the given arguments, e.g.
     *
     *      * 
     * Object[] a = $("test", 4);
     * 
     * 
     *
     * @param args which should be contained in the resulting {@link Object} array
     * @return an {@link Object} array containing all the given {@code args}
     * @see #$$
     */
    public static Object[] $(Object... args) { // define it with  produces var-args warning on user side for java < 6
        return com.tngtech.junit.dataprovider.DataProviders.$(args);
    }

    /**
     * Helper method to create an array of the given {@link Object} arrays, e.g.
     *
     *      * 
     * // @formatter:off
     * Object[][] b = $$(
     *          $("",        0),
     *          $("test",    4),
     *          $("foo bar", 7),
     *      );
     * // @formatter:on
     * 
     * 
     *
     * @param args which should be contained in the resulting array of {@link Object} array
     * @return an array of {@link Object} arrays containing all the given {@code args}
     * @see #$
     */
    public static Object[][] $$(Object[]... args) {
        return com.tngtech.junit.dataprovider.DataProviders.$$(args);
    }

    /**
     * Creates a dataprovider test for each argument.
     *
     * @param args which are wrapped in {@link Object} arrays and combined to {@link Object}{@code [][]}
     * @return an array which contains {@link Object} arrays for each single argument
     */
    public static Object[][] testForEach(Object... args) {
        return com.tngtech.junit.dataprovider.DataProviders.testForEach(args);
    }

    /**
     * Creates a dataprovider test for each element in the given {@link Iterable}.
     *
     * @param  the type of elements returned by the given {@link Iterable}
     * @param args which are wrapped in {@link Object} arrays and combined to {@link Object}{@code [][]}
     * @return an array which contains {@link Object} arrays for each single element in the given {@link Iterable}
     * @throws NullPointerException iif given {@code args} is {@code null}
     * @deprecated since 1.12.0 {@link Iterable}{@code } can directly be returned from any dataprovider method
     */
    @Deprecated
    public static  Object[][] testForEach(Iterable args) {
        checkNotNull(args, "args must not be null");

        List list = new ArrayList();
        for (T arg : args) {
            list.add(arg);
        }
        return testForEach(list.toArray());
    }

    /**
     * Creates a dataprovider test for each value in the given {@link Enum} class.
     *
     * @param  the type of the enum type subclass modeled by the given {@code Class}
     * @param enumClass for which each value is wrapped into an array of {@link Object} arrays
     * @return an array which contains {@link Object} arrays for each single value in the given {@link Enum}
     * @throws NullPointerException iif given {@code enumClass} is {@code null}
     */
    public static > Object[][] testForEach(Class enumClass) {
        return com.tngtech.junit.dataprovider.DataProviders.testForEach(enumClass);
    }

    /**
     * Creates a dataprovider test for each combination of elements of the two provided data providers.
     *
     *      * 
     * Object[][] r = crossProduct(dataProviderMethod1, dataProviderMethod2);
     * 
     * 
     *
     * @param rows1 of first dataprovider which should be cross producted with the second
     * @param rows2 of second dataprovider which should be cross producted with the first
     * @return an {@link Object} array array containing the cross product of the given {@code rows}
     */
    public static Object[][] crossProduct(Object[][] rows1, Object[][] rows2) {
        return com.tngtech.junit.dataprovider.DataProviders.crossProduct(rows1, rows2);
    }
}