Module org.junit.jupiter.params

Package org.junit.jupiter.params.converter

Class DefaultArgumentConverter

java.lang.Object

org.junit.jupiter.params.converter.DefaultArgumentConverter

All Implemented Interfaces:

ArgumentConverter

@API(status=INTERNAL,
     since="5.0")
public class DefaultArgumentConverter
extends Object
implements ArgumentConverter

DefaultArgumentConverter is the default implementation of the ArgumentConverter API.

The DefaultArgumentConverter is able to convert from strings to a number of primitive types and their corresponding wrapper types (Byte, Short, Integer, Long, Float, and Double), date and time types from the java.time package, and some additional common Java types such as File, BigDecimal, BigInteger, Currency, Locale, URI, URL, UUID, etc.

If the source and target types are identical the source object will not be modified.

Since:

5.0

See Also:

• ArgumentConverter
• ConversionSupport

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_LOCALE_CONVERSION_FORMAT_PROPERTY_NAME	Property name used to set the format for the conversion of Locale arguments: "junit.jupiter.params.arguments.conversion.locale.format"

Constructor Summary

Constructors

Constructor	Description
DefaultArgumentConverter(ExtensionContext context)

Method Summary

Modifier and Type	Method	Description
final Object	convert(Object source, Class<?> targetType, ClassLoader classLoader)
final Object	convert(Object source, ParameterContext context)	Convert the supplied source object according to the supplied context.
final Object	convert(Object source, FieldContext context)	Convert the supplied source object according to the supplied context.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LOCALE_CONVERSION_FORMAT_PROPERTY_NAME

public static final String DEFAULT_LOCALE_CONVERSION_FORMAT_PROPERTY_NAME

Property name used to set the format for the conversion of Locale arguments: "junit.jupiter.params.arguments.conversion.locale.format"

Supported Values

• bcp_47: uses the IETF BCP 47 language tag format, delegating the conversion to Locale.forLanguageTag(String)
• iso_639: uses the ISO 639 alpha-2 or alpha-3 language code format, delegating the conversion to Locale(String)

If not specified, the default is bcp_47.

Since:

5.13

See Also:

• Constant Field Values

Constructor Details

DefaultArgumentConverter

public DefaultArgumentConverter(ExtensionContext context)

Method Details

convert

public final Object convert(Object source,
 ParameterContext context)

Description copied from interface: ArgumentConverter

Convert the supplied source object according to the supplied context.

Specified by:

convert in interface ArgumentConverter

Parameters:

source - the source object to convert; may be null

context - the parameter context where the converted object will be supplied; never null

Returns:

the converted object; may be null but only if the target type is a reference type

convert

public final Object convert(Object source,
 FieldContext context)
                     throws ArgumentConversionException

Description copied from interface: ArgumentConverter

Convert the supplied source object according to the supplied context.

Specified by:

convert in interface ArgumentConverter

Parameters:

source - the source object to convert; may be null

context - the field context where the converted object will be injected; never null

Returns:

the converted object; may be null but only if the target type is a reference type

Throws:

ArgumentConversionException - if an error occurs during the conversion

convert

public final Object convert(Object source,
 Class<?> targetType,
 ClassLoader classLoader)