org.springframework.data.convert

Class PropertyValueConverterRegistrar<P extends PersistentProperty<P>>

java.lang.Object

org.springframework.data.convert.PropertyValueConverterRegistrar<P>

public class PropertyValueConverterRegistrar<P extends PersistentProperty<P>>
extends Object

Configuration class used to register a PropertyValueConverter with a SimplePropertyValueConverterRegistry that can be used in PropertyValueConversions.

It is possible to register type safe converters via registerConverter(Class, Function)

 registrar.registerConverter(Person.class, Person::getName) //
                .writing(StringConverter::encrypt) //
                .reading(StringConverter::decrypt);
 

Since:

2.7

Author:

Christoph Strobl, Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyValueConverterRegistrar.ReadingConverterRegistrationBuilder<T,S,R,P extends PersistentProperty<P>> Helper class used to build a fluent API to register how to read a database value into a domain object property.
static class	PropertyValueConverterRegistrar.WritingConverterRegistrationBuilder<T,S,P extends PersistentProperty<P>> Helper class used to build up a fluent registration API starting with writing.

Constructor Summary

Constructors

Constructor and Description
PropertyValueConverterRegistrar()

Method Summary

Modifier and Type	Method and Description
ValueConverterRegistry<P>	buildRegistry() Obtain the SimplePropertyValueConverterRegistry.
PropertyValueConverterRegistrar<P>	registerConverter(Class<?> type, String path, PropertyValueConverter<?,?,? extends ValueConversionContext<?>> converter) Register the given converter for the given type and property identified by its name.
<T,S> PropertyValueConverterRegistrar.WritingConverterRegistrationBuilder<T,S,P>	registerConverter(Class<T> type, Function<T,S> property) Starts a converter registration by pointing to a property of a domain type.
<T,S> PropertyValueConverterRegistrar.WritingConverterRegistrationBuilder<T,S,P>	registerConverter(Class<T> type, String propertyName, Class<S> propertyType) Starts a converter registration by pointing to a property of a domain type.
void	registerConvertersIn(ValueConverterRegistry<P> target) Register collected converters within the given registry.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyValueConverterRegistrar

public PropertyValueConverterRegistrar()

Method Detail

registerConverter

public <T,S> PropertyValueConverterRegistrar.WritingConverterRegistrationBuilder<T,S,P> registerConverter(Class<T> type,
                                                                                                          Function<T,S> property)

Starts a converter registration by pointing to a property of a domain type.

Type Parameters:

T - the domain type

S - the property type

Parameters:

type - the domain type to obtain the property from

property - a Function to describe the property to be referenced. Usually a method handle to a getter.

Returns:

will never be null.

registerConverter

public <T,S> PropertyValueConverterRegistrar.WritingConverterRegistrationBuilder<T,S,P> registerConverter(Class<T> type,
                                                                                                          String propertyName,
                                                                                                          Class<S> propertyType)

Starts a converter registration by pointing to a property of a domain type.

Type Parameters:

T - the domain type

S - the property type

Parameters:

type - the domain type to obtain the property from

propertyName - a Function to describe the property to be referenced. Usually a method handle to a getter.

Returns:

will never be null.

registerConverter

public PropertyValueConverterRegistrar<P> registerConverter(Class<?> type,
                                                            String path,
                                                            PropertyValueConverter<?,?,? extends ValueConversionContext<?>> converter)

Register the given converter for the given type and property identified by its name.

Parameters:

type - the domain type to obtain the property from

path - the property name.

converter - the converter to apply.

Returns:

this.

registerConvertersIn

public void registerConvertersIn(@NonNull
                                 ValueConverterRegistry<P> target)

Register collected converters within the given registry.

Parameters:

target - ValueConverterRegistry from which to register converters; must not be null.

Throws:

IllegalArgumentException - if the ValueConverterRegistry is null.

See Also:

ValueConverterRegistry

buildRegistry

@NonNull
public ValueConverterRegistry<P> buildRegistry()

Obtain the SimplePropertyValueConverterRegistry.

Returns:

new instance of SimplePropertyValueConverterRegistry.