Module spring.data.mongodb

Package org.springframework.data.mongodb.core.convert

Class MongoCustomConversions.MongoConverterConfigurationAdapter

java.lang.Object

org.springframework.data.mongodb.core.convert.MongoCustomConversions.MongoConverterConfigurationAdapter

Enclosing class:

MongoCustomConversions

public static class MongoCustomConversions.MongoConverterConfigurationAdapter
extends Object

MongoCustomConversions.MongoConverterConfigurationAdapter encapsulates creation of CustomConversions.ConverterConfiguration with MongoDB specifics.

Since:

2.3

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
MongoConverterConfigurationAdapter()

Method Summary

Modifier and Type	Method	Description
MongoCustomConversions.MongoConverterConfigurationAdapter	configurePropertyConversions(Consumer<PropertyValueConverterRegistrar<MongoPersistentProperty>> configurationAdapter)	Gateway to register property specific converters.
static MongoCustomConversions.MongoConverterConfigurationAdapter	from(List<?> converters)	Create a MongoCustomConversions.MongoConverterConfigurationAdapter using the provided converters and our own codecs for JSR-310 types.
MongoCustomConversions.MongoConverterConfigurationAdapter	registerConverter(Converter<?,?> converter)	Add a custom Converter implementation.
MongoCustomConversions.MongoConverterConfigurationAdapter	registerConverterFactory(ConverterFactory<?,?> converterFactory)	Add a custom ConverterFactory implementation.
MongoCustomConversions.MongoConverterConfigurationAdapter	registerConverters(Collection<?> converters)	Add converters, factories, converter-aware objects, and generic converters.
MongoCustomConversions.MongoConverterConfigurationAdapter	registerPropertyValueConverterFactory(PropertyValueConverterFactory converterFactory)	Add a custom/default PropertyValueConverterFactory implementation used to serve PropertyValueConverter.
MongoCustomConversions.MongoConverterConfigurationAdapter	setPropertyValueConversions(PropertyValueConversions valueConversions)	Deprecated. since 4.2.
MongoCustomConversions.MongoConverterConfigurationAdapter	useNativeDriverJavaTimeCodecs()	Use the native MongoDB Java Driver codes for LocalDate, LocalTime and LocalDateTime using a ZoneOffset.UTC.
MongoCustomConversions.MongoConverterConfigurationAdapter	useNativeDriverJavaTimeCodecs(boolean useNativeDriverJavaTimeCodecs)	Set whether to or not to use the native MongoDB Java Driver codes for LocalDate, LocalTime and LocalDateTime using a ZoneOffset.UTC.
MongoCustomConversions.MongoConverterConfigurationAdapter	useSpringDataJavaTimeCodecs()	Use SpringData Jsr310 converters for LocalDate, LocalTime and LocalDateTime using the ZoneId.systemDefault().
MongoCustomConversions.MongoConverterConfigurationAdapter	withPropertyValueConversions(PropertyValueConversions valueConversions)	Optionally set the PropertyValueConversions to be applied during mapping.

Methods inherited from class java.lang.Object

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

Constructor Details

MongoConverterConfigurationAdapter

public MongoConverterConfigurationAdapter()

Method Details

from

public static MongoCustomConversions.MongoConverterConfigurationAdapter from(List<?> converters)

Create a MongoCustomConversions.MongoConverterConfigurationAdapter using the provided converters and our own codecs for JSR-310 types.

Parameters:

converters - must not be null.

Returns:

registerConverter

public MongoCustomConversions.MongoConverterConfigurationAdapter registerConverter(Converter<?,?> converter)

Add a custom Converter implementation.

Parameters:

converter - must not be null.

Returns:

this.

registerConverters

public MongoCustomConversions.MongoConverterConfigurationAdapter registerConverters(Collection<?> converters)

Add converters, factories, converter-aware objects, and generic converters.

Parameters:

converters - must not be null nor contain null values.

Returns:

this.

registerConverterFactory

public MongoCustomConversions.MongoConverterConfigurationAdapter registerConverterFactory(ConverterFactory<?,?> converterFactory)

Add a custom ConverterFactory implementation.

Parameters:

converterFactory - must not be null.

Returns:

this.

registerPropertyValueConverterFactory

public MongoCustomConversions.MongoConverterConfigurationAdapter registerPropertyValueConverterFactory(PropertyValueConverterFactory converterFactory)

Add a custom/default PropertyValueConverterFactory implementation used to serve PropertyValueConverter.

Parameters:

converterFactory - must not be null.

Returns:

this.

Since:

3.4

configurePropertyConversions

public MongoCustomConversions.MongoConverterConfigurationAdapter configurePropertyConversions(Consumer<PropertyValueConverterRegistrar<MongoPersistentProperty>> configurationAdapter)

Gateway to register property specific converters.

Parameters:

configurationAdapter - must not be null.

Returns:

this.

Since:

3.4

useNativeDriverJavaTimeCodecs

public MongoCustomConversions.MongoConverterConfigurationAdapter useNativeDriverJavaTimeCodecs(boolean useNativeDriverJavaTimeCodecs)

Set whether to or not to use the native MongoDB Java Driver codes for LocalDate, LocalTime and LocalDateTime using a ZoneOffset.UTC.

Parameters:

useNativeDriverJavaTimeCodecs -

Returns:

this.

useNativeDriverJavaTimeCodecs

public MongoCustomConversions.MongoConverterConfigurationAdapter useNativeDriverJavaTimeCodecs()

Use the native MongoDB Java Driver codes for LocalDate, LocalTime and LocalDateTime using a ZoneOffset.UTC.

Returns:

this.

See Also:

• useNativeDriverJavaTimeCodecs(boolean)

useSpringDataJavaTimeCodecs

public MongoCustomConversions.MongoConverterConfigurationAdapter useSpringDataJavaTimeCodecs()

Use SpringData Jsr310 converters for LocalDate, LocalTime and LocalDateTime using the ZoneId.systemDefault().

Returns:

this.

See Also:

• useNativeDriverJavaTimeCodecs(boolean)

setPropertyValueConversions

@Deprecated(since="4.2.0")
public MongoCustomConversions.MongoConverterConfigurationAdapter setPropertyValueConversions(PropertyValueConversions valueConversions)

Deprecated.

since 4.2. Use withPropertyValueConversions(PropertyValueConversions) instead.

Optionally set the PropertyValueConversions to be applied during mapping.

Use this method if configurePropertyConversions(Consumer) and registerPropertyValueConverterFactory(PropertyValueConverterFactory) are not sufficient.

Parameters:

valueConversions - must not be null.

Returns:

this.

Since:

3.4

withPropertyValueConversions

public MongoCustomConversions.MongoConverterConfigurationAdapter withPropertyValueConversions(PropertyValueConversions valueConversions)

Optionally set the PropertyValueConversions to be applied during mapping.

Use this method if configurePropertyConversions(Consumer) and registerPropertyValueConverterFactory(PropertyValueConverterFactory) are not sufficient.

Parameters:

valueConversions - must not be null.

Returns:

this.

Since:

4.2