Interface Arguments
-
@API(status=EXPERIMENTAL, since="5.0") public interface Arguments
Argumentsis an abstraction that provides access to an array of objects to be used for invoking a@ParameterizedTestmethod.A
Streamof suchArgumentswill typically be provided by anArgumentsProvider.- Since:
- 5.0
- See Also:
ParameterizedTest,ArgumentsSource,ArgumentsProvider,ArgumentConverter- 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
ArgumentConverterto convert some of the arguments from one type to another.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static Argumentsarguments(Object... arguments)Factory method for creating an instance ofArgumentsbased on the suppliedarguments.Object[]get()Get the arguments used for an invocation of the@ParameterizedTestmethod.static Argumentsof(Object... arguments)Factory method for creating an instance ofArgumentsbased on the suppliedarguments.
-
-
-
Method Detail
-
get
Object[] get()
Get the arguments used for an invocation of the@ParameterizedTestmethod.- Returns:
- the arguments; must not be
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
static Arguments of(Object... arguments)
Factory method for creating an instance ofArgumentsbased 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(Object...)
-
arguments
@API(status=EXPERIMENTAL, since="5.3") static Arguments arguments(Object... arguments)
Factory method for creating an instance ofArgumentsbased 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
-
-