Class AnnotationBasedArgumentConverter<A extends Annotation>

java.lang.Object

org.junit.jupiter.params.converter.AnnotationBasedArgumentConverter<A>

All Implemented Interfaces:

Consumer<A>, ArgumentConverter, AnnotationConsumer<A>

@API(status=MAINTAINED,
     since="5.13.3")
public abstract class AnnotationBasedArgumentConverter<A extends Annotation>
extends Object
implements ArgumentConverter, AnnotationConsumer<A>

AnnotationBasedArgumentConverter is an abstract base class for ArgumentConverter implementations that also need to consume an annotation in order to perform the conversion.

Since:

5.10

See Also:

• ArgumentConverter
• AnnotationConsumer
• SimpleArgumentConverter

Constructor Summary

Constructors

Constructor	Description
AnnotationBasedArgumentConverter()

Method Summary

Modifier and Type	Method	Description
final void	accept(A annotation)
protected abstract @Nullable Object	convert(@Nullable Object source, Class<?> targetType, A annotation)	Convert the supplied source object into the supplied targetType, based on metadata in the provided annotation.
final @Nullable Object	convert(@Nullable Object source, ParameterContext context)	Convert the supplied source object according to the supplied context.
final @Nullable Object	convert(@Nullable 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

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Details

AnnotationBasedArgumentConverter

public AnnotationBasedArgumentConverter()

Method Details

accept

public final void accept(A annotation)

Specified by:

accept in interface Consumer<A extends Annotation>

convert

public final @Nullable Object convert(@Nullable Object source,
 ParameterContext 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 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

Throws:

ArgumentConversionException - if an error occurs during the conversion

convert

public final @Nullable Object convert(@Nullable 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

protected abstract @Nullable Object convert(@Nullable Object source,
 Class<?> targetType,
 A annotation)
                                     throws ArgumentConversionException

Convert the supplied source object into the supplied targetType, based on metadata in the provided annotation.

Parameters:

source - the source object to convert; may be null

targetType - the target type the source object should be converted into; never null

annotation - the annotation to process; never null

Returns:

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

Throws:

ArgumentConversionException - in case an error occurs during the conversion