com.tngtech.java.junit.dataprovider

Annotation Type UseDataProvider

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface UseDataProvider

Annotate a test method for using it with a dataprovider. The resolver() is used to find a proper dataprovider.

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	DEFAULT_VALUE This is the default value for value().

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<?>[]	location One or multiple locations where the DataProviderMethodResolver can look out for a proper dataprovider method.
java.lang.Class<? extends DataProviderMethodResolver>[]	resolver The resolvers used to derive the dataprovider method from.
UseDataProvider.ResolveStrategy	resolveStrategy
java.lang.String	value A value to derive the dataprovider method from.

Field Detail

DEFAULT_VALUE

public static final java.lang.String DEFAULT_VALUE

This is the default value for value(). If used the dataprovider name is tried to be guessed (= convention over configuration) in the in value() described order.

Element Detail

value

public abstract java.lang.String value

A value to derive the dataprovider method from. In which way depends on the given resolver(). Defaults to DEFAULT_VALUE.

Returns:

a value from which the dataprovider method can be derived

Default:

"<use_convention>"

location

public abstract java.lang.Class<?>[] location

One or multiple locations where the DataProviderMethodResolver can look out for a proper dataprovider method. It depends on the provided resolver() how this is used.

Returns:

a array of Classes which could be used to derive the dataprovider method

Default:

{}

resolver

public abstract java.lang.Class<? extends DataProviderMethodResolver>[] resolver

The resolvers used to derive the dataprovider method from. It is tried until the first resolver returns a proper dataprovider method (= not null) or no more resolvers are available.

Returns:

the resolver which are used to derive the dataprovider method

Default:

com.tngtech.java.junit.dataprovider.internal.DefaultDataProviderMethodResolver.class

resolveStrategy

public abstract UseDataProvider.ResolveStrategy resolveStrategy

Returns:

strategy how to resolve the dataprovider methods which corresponds to the test method where this annotation is applied.

See Also:

UseDataProvider.ResolveStrategy

Default:

com.tngtech.java.junit.dataprovider.UseDataProvider.ResolveStrategy.UNTIL_FIRST_MATCH