Package org.junit.jupiter.params.provider

Interface ArgumentsProvider

All Known Implementing Classes:

AnnotationBasedArgumentsProvider, CsvArgumentsProvider, CsvFileArgumentsProvider, EmptyArgumentsProvider, EnumArgumentsProvider, FieldArgumentsProvider, MethodArgumentsProvider, NullArgumentsProvider, ValueArgumentsProvider

@API(status=STABLE,
     since="5.7")
public interface ArgumentsProvider

An ArgumentsProvider is responsible for providing a stream of arguments to be passed to a @ParameterizedClass or @ParameterizedTest.

An ArgumentsProvider can be registered via the @ArgumentsSource annotation.

Implementations must provide a no-args constructor or a single unambiguous constructor to use parameter resolution.

Since:

5.0

See Also:

ParameterizedClass, ParameterizedTest, ArgumentsSource, Arguments, AnnotationConsumer

Method Summary

Modifier and Type	Method	Description
default java.util.stream.Stream<? extends Arguments>	provideArguments(org.junit.jupiter.api.extension.ExtensionContext context)	Deprecated. Please implement provideArguments(ParameterDeclarations, ExtensionContext) instead.
default java.util.stream.Stream<? extends Arguments>	provideArguments(ParameterDeclarations parameters, org.junit.jupiter.api.extension.ExtensionContext context)	Provide a Stream of Arguments to be passed to a @ParameterizedClass or @ParameterizedTest.

Method Detail

provideArguments

@Deprecated
@API(status=DEPRECATED,
     since="5.13")
default java.util.stream.Stream<? extends Arguments> provideArguments(org.junit.jupiter.api.extension.ExtensionContext context)
                                                               throws java.lang.Exception

Deprecated.

Please implement provideArguments(ParameterDeclarations, ExtensionContext) instead.

Provide a Stream of Arguments to be passed to a @ParameterizedTest method.

Parameters:

context - the current extension context; never null

Returns:

a stream of arguments; never null

Throws:

java.lang.Exception

provideArguments

@API(status=MAINTAINED,
     since="5.13.3")
default java.util.stream.Stream<? extends Arguments> provideArguments(ParameterDeclarations parameters,
                                                                      org.junit.jupiter.api.extension.ExtensionContext context)
                                                               throws java.lang.Exception

Provide a Stream of Arguments to be passed to a @ParameterizedClass or @ParameterizedTest.

Parameters:

parameters - the parameter declarations for the parameterized class or test; never null

context - the current extension context; never null

Returns:

a stream of arguments; never null

Throws:

java.lang.Exception

Since:

5.13