org.junit.jupiter.params.provider

Class AnnotationBasedArgumentsProvider<A extends java.lang.annotation.Annotation>

java.lang.Object

org.junit.jupiter.params.provider.AnnotationBasedArgumentsProvider<A>

All Implemented Interfaces:

java.util.function.Consumer<A>, ArgumentsProvider, AnnotationConsumer<A>

Direct Known Subclasses:

CsvArgumentsProvider, CsvFileArgumentsProvider, EnumArgumentsProvider, MethodArgumentsProvider, ValueArgumentsProvider

@API(status=EXPERIMENTAL,
     since="5.10")
public abstract class AnnotationBasedArgumentsProvider<A extends java.lang.annotation.Annotation>
extends java.lang.Object
implements ArgumentsProvider, AnnotationConsumer<A>

AnnotationBasedArgumentsProvider is an abstract base class for ArgumentsProvider implementations that also need to consume an annotation in order to provide the arguments.

Since:

5.10

See Also:

ParameterizedTest, ArgumentsSource, Arguments, ArgumentsProvider, AnnotationConsumer

Field Summary

Fields

Modifier and Type	Field and Description
private A	annotation

Constructor Summary

Constructors

Constructor and Description
AnnotationBasedArgumentsProvider()

Method Summary

Modifier and Type	Method and Description
void	accept(A annotation)
java.util.stream.Stream<? extends Arguments>	provideArguments(ExtensionContext context) Provide a Stream of Arguments to be passed to a @ParameterizedTest method.
protected abstract java.util.stream.Stream<? extends Arguments>	provideArguments(ExtensionContext context, A annotation) Provide a Stream of Arguments — based on metadata in the provided annotation — to be passed to a @ParameterizedTest method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Field Detail

annotation

private A extends java.lang.annotation.Annotation annotation

Constructor Detail

AnnotationBasedArgumentsProvider

public AnnotationBasedArgumentsProvider()

Method Detail

accept

public final void accept(A annotation)

Specified by:

accept in interface java.util.function.Consumer<A extends java.lang.annotation.Annotation>

provideArguments

public final java.util.stream.Stream<? extends Arguments> provideArguments(ExtensionContext context)

Description copied from interface: ArgumentsProvider

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

Specified by:

provideArguments in interface ArgumentsProvider

Parameters:

context - the current extension context; never null

Returns:

a stream of arguments; never null

provideArguments

protected abstract java.util.stream.Stream<? extends Arguments> provideArguments(ExtensionContext context,
                                                                                 A annotation)

Provide a Stream of Arguments — based on metadata in the provided annotation — to be passed to a @ParameterizedTest method.

Parameters:

context - the current extension context; never null

annotation - the annotation to process; never null

Returns:

a stream of arguments; never null