Package org.springframework.data.convert

Class SimplePropertyValueConversions

java.lang.Object

org.springframework.data.convert.SimplePropertyValueConversions

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, PropertyValueConversions

public class SimplePropertyValueConversions
extends Object
implements PropertyValueConversions, org.springframework.beans.factory.InitializingBean

PropertyValueConversions implementation allowing a PropertyValueConverterFactory creating converters to be chosen. Activating cahing allows converters to be reused.

Providing a SimplePropertyValueConverterRegistry adds path configured converter instances.

This class should be initialized. If not, init() will be called on the first attempt of converter retrieval.

Since:

2.7

Author:

Christoph Strobl, Mark Paluch

See Also:

• PropertyValueConversions
• InitializingBean

Constructor Summary

Constructors

Constructor	Description
SimplePropertyValueConversions()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Initializes this SimplePropertyValueConversions instance.
PropertyValueConverterFactory	getConverterFactory()	Returns the configured PropertyValueConverterFactory responsible for creating the actual PropertyValueConverter.
<DV, SV, P extends PersistentProperty<P>, D extends ValueConversionContext<P>> PropertyValueConverter<DV,SV,D>	getValueConverter(P property)	Get the converter registered for the given property.
ValueConverterRegistry<?>	getValueConverterRegistry()	Get the ValueConverterRegistry used for path configured converters.
boolean	hasValueConverter(PersistentProperty<?> property)	Determines whether a PropertyValueConverter has been registered for the given property.
void	init()	May be called just once to initialize the underlying factory with its values.
void	setConverterCacheEnabled(boolean converterCacheEnabled)	Configure whether to use converter the cache.
void	setConverterFactory(PropertyValueConverterFactory converterFactory)	Set the PropertyValueConverterFactory responsible for creating the actual PropertyValueConverter.
void	setValueConverterRegistry(ValueConverterRegistry<?> valueConverterRegistry)	Set the converter registry used for path configured converters.

Methods inherited from class java.lang.Object

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

Constructor Details

SimplePropertyValueConversions

public SimplePropertyValueConversions()

Method Details

setConverterFactory

public void setConverterFactory(@Nullable
 PropertyValueConverterFactory converterFactory)

Set the PropertyValueConverterFactory responsible for creating the actual PropertyValueConverter.

Parameters:

converterFactory - PropertyValueConverterFactory used to create the actual PropertyValueConverter.

See Also:

• PropertyValueConverterFactory

getConverterFactory

@Nullable
public PropertyValueConverterFactory getConverterFactory()

Returns the configured PropertyValueConverterFactory responsible for creating the actual PropertyValueConverter.

Returns:

the configured PropertyValueConverterFactory; can be null.

See Also:

• PropertyValueConverterFactory

setValueConverterRegistry

public void setValueConverterRegistry(@Nullable
 ValueConverterRegistry<?> valueConverterRegistry)

Set the converter registry used for path configured converters.

This is short for adding a PropertyValueConverterFactories.ConfiguredInstanceServingValueConverterFactory at the end of a PropertyValueConverterFactories.ChainedPropertyValueConverterFactory.

Parameters:

valueConverterRegistry - registry of PropertyValueConverters.

See Also:

• ValueConverterRegistry

getValueConverterRegistry

@Nullable
public ValueConverterRegistry<?> getValueConverterRegistry()

Get the ValueConverterRegistry used for path configured converters.

Returns:

the configured ValueConverterRegistry; can be null.

See Also:

• ValueConverterRegistry

setConverterCacheEnabled

public void setConverterCacheEnabled(boolean converterCacheEnabled)

Configure whether to use converter the cache. Enabled by default.

Parameters:

converterCacheEnabled - set to true to enable caching of converter instances.

hasValueConverter

public boolean hasValueConverter(PersistentProperty<?> property)

Determines whether a PropertyValueConverter has been registered for the given property.

Specified by:

hasValueConverter in interface PropertyValueConversions

Parameters:

property - PersistentProperty to evaluate.

Returns:

true if a PropertyValueConverter has been registered for the given property.

See Also:

• PersistentProperty

getValueConverter

@NonNull
public <DV,
SV,
P extends PersistentProperty<P>,
D extends ValueConversionContext<P>>
PropertyValueConverter<DV,SV,D> getValueConverter(P property)

Description copied from interface: PropertyValueConversions

Get the converter registered for the given property.

Specified by:

getValueConverter in interface PropertyValueConversions

Type Parameters:

DV - domain-specific type

SV - store-native type

P - conversion context type

Parameters:

property - PersistentProperty used to look up the registered PropertyValueConverter; must not be null.

Returns:

the PropertyValueConverter registered for the given PersistentProperty; never null.

See Also:

• PropertyValueConversions.hasValueConverter(PersistentProperty)
• PropertyValueConverter
• PersistentProperty

init

public void init()

May be called just once to initialize the underlying factory with its values.

afterPropertiesSet

public void afterPropertiesSet()

Initializes this SimplePropertyValueConversions instance.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

See Also:

• init()