Package org.junit.jupiter.params.aggregator

Class DefaultArgumentsAccessor

java.lang.Object

org.junit.jupiter.params.aggregator.DefaultArgumentsAccessor

All Implemented Interfaces:

ArgumentsAccessor

@API(status=INTERNAL,
     since="5.2")
public class DefaultArgumentsAccessor
extends java.lang.Object
implements ArgumentsAccessor

Default implementation of the ArgumentsAccessor API.

Delegates conversion to DefaultArgumentConverter.

Since:

5.2

See Also:

ArgumentsAccessor, DefaultArgumentConverter, ParameterizedTest

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.Object[]	arguments
private java.util.function.BiFunction<java.lang.Object,java.lang.Class<?>,java.lang.Object>	converter
private int	invocationIndex

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DefaultArgumentsAccessor(java.util.function.BiFunction<java.lang.Object,java.lang.Class<?>,java.lang.Object> converter, int invocationIndex, java.lang.Object... arguments)

Method Summary

Modifier and Type	Method	Description
static DefaultArgumentsAccessor	create(org.junit.jupiter.api.extension.ExtensionContext context, int invocationIndex, java.lang.ClassLoader classLoader, java.lang.Object[] arguments)
java.lang.Object	get(int index)	Get the value of the argument at the given index as an Object.
<T> T	get(int index, java.lang.Class<T> requiredType)	Get the value of the argument at the given index as an instance of the required type.
java.lang.Boolean	getBoolean(int index)	Get the value of the argument at the given index as a Boolean, performing automatic type conversion as necessary.
java.lang.Byte	getByte(int index)	Get the value of the argument at the given index as a Byte, performing automatic type conversion as necessary.
java.lang.Character	getCharacter(int index)	Get the value of the argument at the given index as a Character, performing automatic type conversion as necessary.
java.lang.Double	getDouble(int index)	Get the value of the argument at the given index as a Double, performing automatic type conversion as necessary.
java.lang.Float	getFloat(int index)	Get the value of the argument at the given index as a Float, performing automatic type conversion as necessary.
java.lang.Integer	getInteger(int index)	Get the value of the argument at the given index as a Integer, performing automatic type conversion as necessary.
int	getInvocationIndex()	Get the index of the current test invocation.
java.lang.Long	getLong(int index)	Get the value of the argument at the given index as a Long, performing automatic type conversion as necessary.
java.lang.Short	getShort(int index)	Get the value of the argument at the given index as a Short, performing automatic type conversion as necessary.
java.lang.String	getString(int index)	Get the value of the argument at the given index as a String, performing automatic type conversion as necessary.
int	size()	Get the number of arguments in this accessor.
java.lang.Object[]	toArray()	Get all arguments in this accessor as an array.
java.util.List<java.lang.Object>	toList()	Get all arguments in this accessor as an immutable list.

Methods inherited from class java.lang.Object

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

Field Detail

invocationIndex

private final int invocationIndex

arguments

private final java.lang.Object[] arguments

converter

private final java.util.function.BiFunction<java.lang.Object,java.lang.Class<?>,java.lang.Object> converter

Constructor Detail

DefaultArgumentsAccessor

private DefaultArgumentsAccessor(java.util.function.BiFunction<java.lang.Object,java.lang.Class<?>,java.lang.Object> converter,
                                 int invocationIndex,
                                 java.lang.Object... arguments)

Method Detail

create

public static DefaultArgumentsAccessor create(org.junit.jupiter.api.extension.ExtensionContext context,
                                              int invocationIndex,
                                              java.lang.ClassLoader classLoader,
                                              java.lang.Object[] arguments)

get

public java.lang.Object get(int index)

Description copied from interface: ArgumentsAccessor

Get the value of the argument at the given index as an Object.

Specified by:

get in interface ArgumentsAccessor

Parameters:

index - the index of the argument to get; must be greater than or equal to zero and less than ArgumentsAccessor.size()

Returns:

the value at the given index, potentially null

get

public <T> T get(int index,
                 java.lang.Class<T> requiredType)

Description copied from interface: ArgumentsAccessor

Get the value of the argument at the given index as an instance of the required type.

Specified by:

get in interface ArgumentsAccessor

Parameters:

index - the index of the argument to get; must be greater than or equal to zero and less than ArgumentsAccessor.size()

requiredType - the required type of the value; never null

Returns:

the value at the given index, potentially null

getCharacter

public java.lang.Character getCharacter(int index)

Description copied from interface: ArgumentsAccessor

Get the value of the argument at the given index as a Character, performing automatic type conversion as necessary.

Specified by:

getCharacter in interface ArgumentsAccessor

Parameters:

index - the index of the argument to get; must be greater than or equal to zero and less than ArgumentsAccessor.size()

Returns:

the value at the given index, potentially null

getBoolean

public java.lang.Boolean getBoolean(int index)

Description copied from interface: ArgumentsAccessor

Get the value of the argument at the given index as a Boolean, performing automatic type conversion as necessary.

Specified by:

getBoolean in interface ArgumentsAccessor

Parameters:

index - the index of the argument to get; must be greater than or equal to zero and less than ArgumentsAccessor.size()

Returns:

the value at the given index, potentially null

getByte

public java.lang.Byte getByte(int index)

Description copied from interface: ArgumentsAccessor

Get the value of the argument at the given index as a Byte, performing automatic type conversion as necessary.

Specified by:

getByte in interface ArgumentsAccessor

Parameters:

index - the index of the argument to get; must be greater than or equal to zero and less than ArgumentsAccessor.size()

Returns:

the value at the given index, potentially null

getShort

public java.lang.Short getShort(int index)

Description copied from interface: ArgumentsAccessor

Get the value of the argument at the given index as a Short, performing automatic type conversion as necessary.

Specified by:

getShort in interface ArgumentsAccessor

Parameters:

index - the index of the argument to get; must be greater than or equal to zero and less than ArgumentsAccessor.size()

Returns:

the value at the given index, potentially null

getInteger

public java.lang.Integer getInteger(int index)

Description copied from interface: ArgumentsAccessor

Get the value of the argument at the given index as a Integer, performing automatic type conversion as necessary.

Specified by:

getInteger in interface ArgumentsAccessor

Parameters:

index - the index of the argument to get; must be greater than or equal to zero and less than ArgumentsAccessor.size()

Returns:

the value at the given index, potentially null

getLong

public java.lang.Long getLong(int index)

Description copied from interface: ArgumentsAccessor

Get the value of the argument at the given index as a Long, performing automatic type conversion as necessary.

Specified by:

getLong in interface ArgumentsAccessor

Parameters:

index - the index of the argument to get; must be greater than or equal to zero and less than ArgumentsAccessor.size()

Returns:

the value at the given index, potentially null

getFloat

public java.lang.Float getFloat(int index)

Description copied from interface: ArgumentsAccessor

Get the value of the argument at the given index as a Float, performing automatic type conversion as necessary.

Specified by:

getFloat in interface ArgumentsAccessor

Parameters:

index - the index of the argument to get; must be greater than or equal to zero and less than ArgumentsAccessor.size()

Returns:

the value at the given index, potentially null

getDouble

public java.lang.Double getDouble(int index)

Description copied from interface: ArgumentsAccessor

Get the value of the argument at the given index as a Double, performing automatic type conversion as necessary.

Specified by:

getDouble in interface ArgumentsAccessor

Parameters:

index - the index of the argument to get; must be greater than or equal to zero and less than ArgumentsAccessor.size()

Returns:

the value at the given index, potentially null

getString

public java.lang.String getString(int index)

Description copied from interface: ArgumentsAccessor

Get the value of the argument at the given index as a String, performing automatic type conversion as necessary.

Specified by:

getString in interface ArgumentsAccessor

Parameters:

index - the index of the argument to get; must be greater than or equal to zero and less than ArgumentsAccessor.size()

Returns:

the value at the given index, potentially null

size

public int size()

Description copied from interface: ArgumentsAccessor

Get the number of arguments in this accessor.

Specified by:

size in interface ArgumentsAccessor

toArray

public java.lang.Object[] toArray()

Description copied from interface: ArgumentsAccessor

Get all arguments in this accessor as an array.

Specified by:

toArray in interface ArgumentsAccessor

toList

public java.util.List<java.lang.Object> toList()

Description copied from interface: ArgumentsAccessor

Get all arguments in this accessor as an immutable list.

Specified by:

toList in interface ArgumentsAccessor

getInvocationIndex

public int getInvocationIndex()

Description copied from interface: ArgumentsAccessor

Get the index of the current test invocation.

Specified by:

getInvocationIndex in interface ArgumentsAccessor