Package org.springframework.data.convert

Interface PropertyValueConverterFactory

public interface PropertyValueConverterFactory

A factory providing value converters.

Depending on the applications' need factories can be chained and the resulting converter may be cached.

Since:

2.7

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method	Description
static PropertyValueConverterFactory	beanFactoryAware(org.springframework.beans.factory.BeanFactory beanFactory)	Obtain a PropertyValueConverterFactory capable of looking up/creating the PropertyValueConverter via the given BeanFactory.
static PropertyValueConverterFactory	caching(PropertyValueConverterFactory factory)	Obtain a PropertyValueConverterFactory that will cache PropertyValueConverter instances per PersistentProperty.
static PropertyValueConverterFactory	chained(List<PropertyValueConverterFactory> factoryList)	Obtain a PropertyValueConverterFactory that will try to obtain a PropertyValueConverter from the given list of factories by returning the first non null one.
static PropertyValueConverterFactory	chained(PropertyValueConverterFactory... factories)	Obtain a PropertyValueConverterFactory that will try to obtain a PropertyValueConverter from the given array of factories by returning the first non null one.
static PropertyValueConverterFactory	configuredInstance(ValueConverterRegistry<?> registrar)	Obtain a PropertyValueConverterFactory capable of looking up the PropertyValueConverter in the given PropertyValueConverterRegistrar.
<DV, SV, C extends ValueConversionContext<?>> PropertyValueConverter<DV,SV,C>	getConverter(Class<? extends PropertyValueConverter<DV,SV,C>> converterType)	Get the converter by its type.
default <DV, SV, P extends ValueConversionContext<?>> PropertyValueConverter<DV,SV,P>	getConverter(PersistentProperty<?> property)	Get the PropertyValueConverter applicable for the given PersistentProperty.
static PropertyValueConverterFactory	simple()	Obtain a simple PropertyValueConverterFactory capable of instantiating PropertyValueConverter implementations via their default Constructor or in case of an Enum accessing the first enum value.

Method Details

getConverter

@Nullable
default <DV,
SV,
P extends ValueConversionContext<?>>
PropertyValueConverter<DV,SV,P> getConverter(PersistentProperty<?> property)

Get the PropertyValueConverter applicable for the given PersistentProperty.

Type Parameters:

DV - domain-specific type.

SV - store-native type.

P - value conversion context to use.

Parameters:

property - must not be null.

Returns:

can be null.

getConverter

@Nullable
<DV,
SV,
C extends ValueConversionContext<?>>
PropertyValueConverter<DV,SV,C> getConverter(Class<? extends PropertyValueConverter<DV,SV,C>> converterType)

Get the converter by its type.

Type Parameters:

DV - domain-specific type.

SV - store-native type.

C - value conversion context to use.

Parameters:

converterType - must not be null.

Returns:

can be null.

simple

static PropertyValueConverterFactory simple()

Obtain a simple PropertyValueConverterFactory capable of instantiating PropertyValueConverter implementations via their default Constructor or in case of an Enum accessing the first enum value.

Returns:

new instance of PropertyValueConverterFactory.

beanFactoryAware

static PropertyValueConverterFactory beanFactoryAware(org.springframework.beans.factory.BeanFactory beanFactory)

Obtain a PropertyValueConverterFactory capable of looking up/creating the PropertyValueConverter via the given BeanFactory.

Parameters:

beanFactory - must not be null.

Returns:

new instance of PropertyValueConverterFactory.

configuredInstance

static PropertyValueConverterFactory configuredInstance(ValueConverterRegistry<?> registrar)

Obtain a PropertyValueConverterFactory capable of looking up the PropertyValueConverter in the given PropertyValueConverterRegistrar.

Parameters:

registrar - must not be null.

Returns:

new instance of PropertyValueConverterFactory.

chained

static PropertyValueConverterFactory chained(PropertyValueConverterFactory... factories)

Obtain a PropertyValueConverterFactory that will try to obtain a PropertyValueConverter from the given array of factories by returning the first non null one.

Parameters:

factories - must not be null nor contain null values.

Returns:

new instance of PropertyValueConverterFactory.

chained

static PropertyValueConverterFactory chained(List<PropertyValueConverterFactory> factoryList)

Obtain a PropertyValueConverterFactory that will try to obtain a PropertyValueConverter from the given list of factories by returning the first non null one.

Parameters:

factoryList - must not be null nor contain null values.

Returns:

new instance of PropertyValueConverterFactory.

caching

static PropertyValueConverterFactory caching(PropertyValueConverterFactory factory)

Obtain a PropertyValueConverterFactory that will cache PropertyValueConverter instances per PersistentProperty.

Parameters:

factory - must not be null.

Returns:

new instance of PropertyValueConverterFactory.