Package org.springframework.data.convert

Class PropertyValueConversionService

java.lang.Object

org.springframework.data.convert.PropertyValueConversionService

public class PropertyValueConversionService
extends Object

Conversion service based on CustomConversions used to convert domain and store values using property-specific converters.

Since:

2.7

Author:

Mark Paluch

See Also:

• PropertyValueConverter

Constructor Summary

Constructors

Constructor	Description
PropertyValueConversionService(CustomConversions conversions)	Constructs a new instance of the PropertyValueConversionService initialized with the given, required CustomConversions for resolving the PropertyValueConversions used to convert PersistentProperty values during data access operations.

Method Summary

Modifier and Type	Method	Description
boolean	hasConverter(PersistentProperty<?> property)	Return true if a PropertyValueConverter is registered for the PersistentProperty.
<P extends PersistentProperty<P>, VCC extends ValueConversionContext<P>> @Nullable Object	read(@Nullable Object value, P property, VCC context)	Convert a value from its store-native representation into its domain-specific type.
<P extends PersistentProperty<P>, VCC extends ValueConversionContext<P>> @Nullable Object	write(@Nullable Object value, P property, VCC context)	Convert a value from its domain-specific value into its store-native representation.

Methods inherited from class java.lang.Object

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

Constructor Details

PropertyValueConversionService

public PropertyValueConversionService(CustomConversions conversions)

Constructs a new instance of the PropertyValueConversionService initialized with the given, required CustomConversions for resolving the PropertyValueConversions used to convert PersistentProperty values during data access operations.

Parameters:

conversions - CustomConversions used to handle domain and store type conversions; must not be null.

Throws:

IllegalArgumentException - if CustomConversions is null.

See Also:

• CustomConversions

Method Details

hasConverter

public boolean hasConverter(PersistentProperty<?> property)

Return true if a PropertyValueConverter is registered for the PersistentProperty.

If this method returns true, it means read(Object, PersistentProperty, ValueConversionContext) and write(Object, PersistentProperty, ValueConversionContext) are capable of handling conversions.

Parameters:

property - property to evaluate for registration.

Returns:

true if a PropertyValueConverter is registered for the PersistentProperty.

See Also:

• PersistentProperty

read

public <P extends PersistentProperty<P>,
VCC extends ValueConversionContext<P>>
@Nullable Object read(@Nullable Object value,
 P property,
 VCC context)

Convert a value from its store-native representation into its domain-specific type.

Type Parameters:

P - property type.

VCC - value conversion context type.

Parameters:

value - the value to convert. Can be null.

property - the underlying property.

context - the context object.

Returns:

the value to be used in the domain model. Can be null.

write

public <P extends PersistentProperty<P>,
VCC extends ValueConversionContext<P>>
@Nullable Object write(@Nullable Object value,
 P property,
 VCC context)

Convert a value from its domain-specific value into its store-native representation.

Type Parameters:

P - property type.

VCC - value conversion context type.

Parameters:

value - the value to convert. Can be null.

property - the underlying property.

context - the context object.

Returns:

the value to be written to the data store. Can be null.