io.micronaut.core.convert.converters

Class MultiValuesConverterFactory.AbstractConverterToMultiValues<T>

java.lang.Object

io.micronaut.core.convert.converters.MultiValuesConverterFactory.AbstractConverterToMultiValues<T>

Type Parameters:

T - The class from which to convert

All Implemented Interfaces:

FormattingTypeConverter<T,ConvertibleMultiValues,Format>, TypeConverter<T,ConvertibleMultiValues>

Direct Known Subclasses:

MultiValuesConverterFactory.IterableToMultiValuesConverter, MultiValuesConverterFactory.MapToMultiValuesConverter, MultiValuesConverterFactory.ObjectToMultiValuesConverter

Enclosing class:

MultiValuesConverterFactory

public abstract static class MultiValuesConverterFactory.AbstractConverterToMultiValues<T>
extends Object
implements FormattingTypeConverter<T,ConvertibleMultiValues,Format>

An abstract class to convert to ConvertibleMultiValues.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConversionService<?>	conversionService

Constructor Summary

Constructors

Constructor and Description
AbstractConverterToMultiValues(ConversionService<?> conversionService)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addDeepObjectValues(ArgumentConversionContext<Object> context, String name, T object, MutableConvertibleMultiValuesMap<String> parameters) Method that adds given value to the parameters in A DEEP_OBJECT format.
protected abstract void	addMutliValues(ArgumentConversionContext<Object> context, String name, T object, MutableConvertibleMultiValuesMap<String> parameters) Method that adds given value to the parameters in a MULTI format.
protected abstract void	addSeparatedValues(ArgumentConversionContext<Object> context, String name, T object, MutableConvertibleMultiValuesMap<String> parameters, Character delimiter) Method that adds given value to the parameters in a format separated by a delimiter.
Class<Format>	annotationType()
Optional<ConvertibleMultiValues>	convert(T object, Class<ConvertibleMultiValues> targetType, ConversionContext conversionContext) Converts from the given source object type to the target type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.convert.TypeConverter

convert, of

Field Detail

conversionService

protected ConversionService<?> conversionService

Constructor Detail

AbstractConverterToMultiValues

public AbstractConverterToMultiValues(ConversionService<?> conversionService)

Method Detail

convert

public Optional<ConvertibleMultiValues> convert(T object,
                                                Class<ConvertibleMultiValues> targetType,
                                                ConversionContext conversionContext)

Description copied from interface: TypeConverter

Converts from the given source object type to the target type. Implementers should take care to return Optional.empty() in case the object is not convertible by catching any necessary exceptions and failing gracefully.

Specified by:

convert in interface TypeConverter<T,ConvertibleMultiValues>

Parameters:

object - The object type

targetType - The target type being converted to

conversionContext - The ConversionContext

Returns:

The converted type or empty if the conversion is not possible

addSeparatedValues

protected abstract void addSeparatedValues(ArgumentConversionContext<Object> context,
                                           String name,
                                           T object,
                                           MutableConvertibleMultiValuesMap<String> parameters,
                                           Character delimiter)

Method that adds given value to the parameters in a format separated by a delimiter.

Parameters:

context - - the context of conversion which has the source type and any present annotations

name - - the name of the parameter

object - - the object that we are converting from

parameters - - the parameters to the value of additional parameter will be added

delimiter - - the required delimiter of the values in the parameter String

addMutliValues

protected abstract void addMutliValues(ArgumentConversionContext<Object> context,
                                       String name,
                                       T object,
                                       MutableConvertibleMultiValuesMap<String> parameters)

Method that adds given value to the parameters in a MULTI format.

Parameters:

context - - the context of conversion which has the source type and any present annotations

name - - the name of the parameter

object - - the object that we are converting from

parameters - - the parameters to the value of additional parameter will be added

addDeepObjectValues

protected abstract void addDeepObjectValues(ArgumentConversionContext<Object> context,
                                            String name,
                                            T object,
                                            MutableConvertibleMultiValuesMap<String> parameters)

Method that adds given value to the parameters in A DEEP_OBJECT format.

Parameters:

context - - the context of conversion which has the source type and any present annotations

name - - the name of the parameter

object - - the object that we are converting from

parameters - - the parameters to the value of additional parameter will be added

annotationType

public Class<Format> annotationType()

Specified by:

annotationType in interface FormattingTypeConverter<T,ConvertibleMultiValues,Format>

Returns:

The annotation type for this formatter