Module spring.data.mongodb

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

Interface MappingMongoConverter.ConversionContext

All Known Implementing Classes:

MappingMongoConverter.DefaultConversionContext

Enclosing class:

MappingMongoConverter

protected static interface MappingMongoConverter.ConversionContext

Conversion context defining an interface for graph-traversal-based conversion of documents. Entrypoint for recursive conversion of Document and other types.

Since:

3.4.3

Method Summary

Modifier and Type	Method	Description
default <S> S	convert(Object source, TypeInformation<? extends S> typeHint)	Converts a source object into target.
<S> S	convert(Object source, TypeInformation<? extends S> typeHint, MappingMongoConverter.ConversionContext context)	Converts a source object into target.
default <S> S	findContextualEntity(MongoPersistentEntity<S> entity, org.bson.Document document)	Lookup a potentially existing entity instance of the given MongoPersistentEntity and Document
default MappingMongoConverter.ConversionContext	forProperty(String name)	Obtain a MappingMongoConverter.ConversionContext for the given property name.
default MappingMongoConverter.ConversionContext	forProperty(MongoPersistentProperty property)	Obtain a MappingMongoConverter.ConversionContext for the given MongoPersistentProperty.
CustomConversions	getCustomConversions()
ObjectPath	getPath()
MongoConverter	getSourceConverter()
MappingMongoConverter.ConversionContext	withPath(ObjectPath currentPath)	Create a new MappingMongoConverter.ConversionContext with currentPath applied.

Method Details

convert

default <S> S convert(Object source,
 TypeInformation<? extends S> typeHint)

Converts a source object into target.

Parameters:

source - must not be null.

typeHint - must not be null.

Returns:

the converted object.

convert

<S> S convert(Object source,
 TypeInformation<? extends S> typeHint,
 MappingMongoConverter.ConversionContext context)

Converts a source object into target.

Parameters:

source - must not be null.

typeHint - must not be null.

context - must not be null.

Returns:

the converted object.

withPath

MappingMongoConverter.ConversionContext withPath(ObjectPath currentPath)

Create a new MappingMongoConverter.ConversionContext with currentPath applied.

Parameters:

currentPath - must not be null.

Returns:

a new MappingMongoConverter.ConversionContext with currentPath applied.

forProperty

default MappingMongoConverter.ConversionContext forProperty(String name)

Obtain a MappingMongoConverter.ConversionContext for the given property name.

Parameters:

name - must not be null.

Returns:

the MappingMongoConverter.ConversionContext to be used for conversion of the given property.

forProperty

default MappingMongoConverter.ConversionContext forProperty(MongoPersistentProperty property)

Obtain a MappingMongoConverter.ConversionContext for the given MongoPersistentProperty.

Parameters:

property - must not be null.

Returns:

the MappingMongoConverter.ConversionContext to be used for conversion of the given property.

findContextualEntity

@Nullable
default <S> S findContextualEntity(MongoPersistentEntity<S> entity,
 org.bson.Document document)

Lookup a potentially existing entity instance of the given MongoPersistentEntity and Document

Type Parameters:

S -

Parameters:

entity -

document -

Returns:

getPath

ObjectPath getPath()

getCustomConversions

CustomConversions getCustomConversions()

getSourceConverter

MongoConverter getSourceConverter()