- All Known Implementing Classes:
Arguments.ArgumentSet
Arguments
is an abstraction that provides access to an array of
objects to be used for invoking a @ParameterizedTest
method.
A Stream
of such Arguments
will
typically be provided by an ArgumentsProvider
.
- Since:
- 5.0
- See Also:
- API Note:
This interface is specifically designed as a simple holder of arguments of a parameterized test. Therefore, if you end up transforming or filtering the arguments, you should consider using one of the following in intermediate steps:
- The standard collections
- Tuples from third-party libraries, e.g., Commons Lang, or javatuples
- Your own data class
Alternatively, you can use an
ArgumentConverter
to convert some of the arguments from one type to another.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
-
Method Summary
Modifier and TypeMethodDescriptionstatic Arguments
Factory method for creating an instance ofArguments
based on the suppliedarguments
.static Arguments.ArgumentSet
argumentSet
(String name, Object... arguments) Object[]
get()
Get the arguments used for an invocation of the@ParameterizedTest
method.static Arguments
Factory method for creating an instance ofArguments
based on the suppliedarguments
.
-
Method Details
-
get
Object[] get()Get the arguments used for an invocation of the@ParameterizedTest
method.- Returns:
- the arguments; never
null
- API Note:
- If you need a type-safe way to access some or all of the arguments, please read the class-level API note.
-
of
Factory method for creating an instance ofArguments
based on the suppliedarguments
.- Parameters:
arguments
- the arguments to be used for an invocation of the test method; must not benull
- Returns:
- an instance of
Arguments
; nevernull
- See Also:
-
arguments
Factory method for creating an instance ofArguments
based on the suppliedarguments
.This method is an alias for
of(java.lang.Object...)
and is intended to be used when statically imported — for example, via:import static org.junit.jupiter.params.provider.Arguments.arguments;
- Parameters:
arguments
- the arguments to be used for an invocation of the test method; must not benull
- Returns:
- an instance of
Arguments
; nevernull
- Since:
- 5.3
- See Also:
-
argumentSet
@API(status=EXPERIMENTAL, since="5.11") static Arguments.ArgumentSet argumentSet(String name, Object... arguments) Factory method for creating anArguments.ArgumentSet
based on the suppliedname
andarguments
.Favor this method over
Arguments.of(...)
andarguments(...)
when you wish to assign a name to the entire set of arguments.This method is well suited to be used as a static import — for example, via:
import static org.junit.jupiter.params.provider.Arguments.argumentSet;
.- Parameters:
name
- the name of the argument set; must not benull
or blankarguments
- the arguments to be used for an invocation of the test method; must not benull
- Returns:
- an
ArgumentSet
; nevernull
- Since:
- 5.11
- See Also:
-