Class AbstractCouchbaseConverter

java.lang.Object

org.springframework.data.couchbase.core.convert.AbstractCouchbaseConverter

All Implemented Interfaces:

InitializingBean, EntityConverter<CouchbasePersistentEntity<?>, CouchbasePersistentProperty, Object, CouchbaseDocument>, EntityReader<Object, CouchbaseDocument>, EntityWriter<Object, CouchbaseDocument>, CouchbaseConverter, CouchbaseWriter<Object, CouchbaseDocument>

Direct Known Subclasses:

MappingCouchbaseConverter

public abstract class AbstractCouchbaseConverter
extends Object
implements CouchbaseConverter, InitializingBean

An abstract CouchbaseConverter that provides the basics for the MappingCouchbaseConverter.

Author:

Michael Nitschinger, Mark Paluch, Michael Reiche, Vipul Gupta

Field Summary

Fields

Modifier and Type	Field	Description
protected CustomConversions	conversions	Holds the custom conversions.
protected final GenericConversionService	conversionService	Contains the conversion service.
protected EntityInstantiators	instantiators	Contains the entity instantiators.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCouchbaseConverter(GenericConversionService conversionService, CustomConversions customConversions)	Create a new converter with custom conversions and hand it over the ConversionService

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Do nothing after the properties set on the bean.
Object	convertForWriteIfNeeded(Object inValue)	This convertForWriteIfNeed takes only the value to convert.
Object	convertForWriteIfNeeded(CouchbasePersistentProperty prop, ConvertingPropertyAccessor<Object> accessor, boolean processValueConverter)	This convertForWriteIfNeeded takes a property and accessor so that the annotations can be accessed (ie.
CustomConversions	getConversions()	return the conversions
ConversionService	getConversionService()	Return the conversion service.
Class<?>	getWriteClassFor(Class<?> clazz)	Return the Class that would actually be stored for a given Class.
void	setCustomConversions(CustomConversions conversions)	Set the custom conversions.
void	setInstantiators(EntityInstantiators instantiators)	Set the entity instantiators.

Methods inherited from class Object

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

Methods inherited from interface CouchbaseConverter

getTypeAlias, getTypeKey

Methods inherited from interface EntityConverter

getMappingContext

Methods inherited from interface EntityReader

read

Methods inherited from interface EntityWriter

write

Field Details

conversionService

protected final GenericConversionService conversionService

Contains the conversion service.

instantiators

protected EntityInstantiators instantiators

Contains the entity instantiators.

conversions

protected CustomConversions conversions

Holds the custom conversions.

Constructor Details

AbstractCouchbaseConverter

protected AbstractCouchbaseConverter(GenericConversionService conversionService,
 CustomConversions customConversions)

Create a new converter with custom conversions and hand it over the ConversionService

Parameters:

conversionService - the conversion service to use.

customConversions - the custom conversions to use

Method Details

getConversionService

public ConversionService getConversionService()

Return the conversion service.

Specified by:

getConversionService in interface EntityConverter<CouchbasePersistentEntity<?>, CouchbasePersistentProperty, Object, CouchbaseDocument>

Returns:

the conversion service.

setCustomConversions

public void setCustomConversions(CustomConversions conversions)

Set the custom conversions. Note that updating conversions requires a subsequent call to register them with the conversionService: conversions.registerConvertersIn(conversionService)

Parameters:

conversions - the conversions.

setInstantiators

public void setInstantiators(EntityInstantiators instantiators)

Set the entity instantiators.

Parameters:

instantiators - the instantiators.

afterPropertiesSet

public void afterPropertiesSet()

Do nothing after the properties set on the bean.

Specified by:

afterPropertiesSet in interface InitializingBean

convertForWriteIfNeeded

public Object convertForWriteIfNeeded(CouchbasePersistentProperty prop,
 ConvertingPropertyAccessor<Object> accessor,
 boolean processValueConverter)

This convertForWriteIfNeeded takes a property and accessor so that the annotations can be accessed (ie. @Encrypted)

Specified by:

convertForWriteIfNeeded in interface CouchbaseConverter

Parameters:

prop - the property to be converted to the class that would actually be stored.

accessor - the property accessor

Returns:

convertForWriteIfNeeded

public Object convertForWriteIfNeeded(Object inValue)

This convertForWriteIfNeed takes only the value to convert. It cannot access the annotations of the Field being converted.

Specified by:

convertForWriteIfNeeded in interface CouchbaseConverter

Parameters:

inValue - the value to be converted to the class that would actually be stored.

Returns:

getWriteClassFor

public Class<?> getWriteClassFor(Class<?> clazz)

Description copied from interface: CouchbaseConverter

Return the Class that would actually be stored for a given Class.

Specified by:

getWriteClassFor in interface CouchbaseConverter

Parameters:

clazz - the source class.

Returns:

the target class that would actually be stored.

See Also:

• CouchbaseConverter.convertForWriteIfNeeded(Object)

getConversions

public CustomConversions getConversions()

Description copied from interface: CouchbaseConverter

return the conversions

Specified by:

getConversions in interface CouchbaseConverter

Returns:

conversions