Package 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, FieldArgumentsProvider, MethodArgumentsProvider, ValueArgumentsProvider

@API(status=MAINTAINED,
     since="5.13.3")
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:

ParameterizedClass, ParameterizedTest, ArgumentsSource, Arguments, ArgumentsProvider, AnnotationConsumer

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<A>	annotations

Constructor Summary

Constructors

Constructor	Description
AnnotationBasedArgumentsProvider()

Method Summary

Modifier and Type	Method	Description
void	accept(A annotation)
protected java.util.stream.Stream<? extends Arguments>	provideArguments(org.junit.jupiter.api.extension.ExtensionContext context, A annotation)	Deprecated. Please implement provideArguments(ParameterDeclarations, ExtensionContext, Annotation) instead.
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.
protected java.util.stream.Stream<? extends Arguments>	provideArguments(ParameterDeclarations parameters, org.junit.jupiter.api.extension.ExtensionContext context, A annotation)	The returned Stream will be properly closed by the default implementation of provideArguments(ParameterDeclarations, ExtensionContext), making it safe to use a resource such as Files.lines().

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.junit.jupiter.params.provider.ArgumentsProvider

provideArguments

Methods inherited from interface java.util.function.Consumer

andThen

Field Detail

annotations

private final java.util.List<A extends java.lang.annotation.Annotation> annotations

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 java.util.stream.Stream<? extends Arguments> provideArguments(ParameterDeclarations parameters,
                                                                     org.junit.jupiter.api.extension.ExtensionContext context)

Description copied from interface: ArgumentsProvider

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

Specified by:

provideArguments in interface ArgumentsProvider

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

provideArguments

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

Deprecated.

Please implement provideArguments(ParameterDeclarations, ExtensionContext, Annotation) instead.

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

provideArguments

protected java.util.stream.Stream<? extends Arguments> provideArguments(ParameterDeclarations parameters,
                                                                        org.junit.jupiter.api.extension.ExtensionContext context,
                                                                        A annotation)

The returned Stream will be properly closed by the default implementation of provideArguments(ParameterDeclarations, ExtensionContext), making it safe to use a resource such as Files.lines().