org.mongodb.morphia.converters

Class Converters

java.lang.Object

org.mongodb.morphia.converters.Converters

Direct Known Subclasses:

CustomConverters, DefaultConverters

public abstract class Converters
extends Object

Defines a bundle of converters

Constructor Summary

Constructors

Constructor and Description
Converters(Mapper mapper) Creates a bundle with a particular Mapper.

Method Summary

Modifier and Type	Method and Description
TypeConverter	addConverter(Class<? extends TypeConverter> clazz) Adds a TypeConverter to this bundle.
TypeConverter	addConverter(TypeConverter tc) Add a type converter.
Object	decode(Class c, Object fromDBObject, MappedField mf) decode the DBObject and provide the corresponding java (type-safe) object NOTE: mf might be null
Object	encode(Class c, Object o) encode the type safe java object into the corresponding DBObject
Object	encode(Object o) encode the type safe java object into the corresponding DBObject
void	fromDBObject(DBObject dbObj, MappedField mf, Object targetEntity) Creates an entity and populates its state based on the dbObject given.
protected TypeConverter	getEncoder(Class c)
protected TypeConverter	getEncoder(Object val, MappedField mf)
boolean	hasDbObjectConverter(Class c)
boolean	hasDbObjectConverter(MappedField field)
boolean	hasSimpleValueConverter(Class c)
boolean	hasSimpleValueConverter(MappedField c)
boolean	hasSimpleValueConverter(Object o)
boolean	isRegistered(Class<? extends TypeConverter> tcClass)
void	removeConverter(TypeConverter tc) Removes the type converter.
void	toDBObject(Object containingObject, MappedField mf, DBObject dbObj, MapperOptions opts) Converts an entity to a DBObject

Methods inherited from class java.lang.Object

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

Constructor Detail

Converters

public Converters(Mapper mapper)

Creates a bundle with a particular Mapper.

Parameters:

mapper - the Mapper to use

Method Detail

addConverter

public TypeConverter addConverter(Class<? extends TypeConverter> clazz)

Adds a TypeConverter to this bundle.

Parameters:

clazz - the converter to add

Returns:

the new instance

addConverter

public TypeConverter addConverter(TypeConverter tc)

Add a type converter. If it is a duplicate for an existing type, it will override that type.

Parameters:

tc - the converter to add

Returns:

the TypeConverter passed in

decode

public Object decode(Class c,
                     Object fromDBObject,
                     MappedField mf)

decode the DBObject and provide the corresponding java (type-safe) object
NOTE: mf might be null

Parameters:

c - the class to create and populate

fromDBObject - the DBObject to use when populating the new instance

mf - the MappedField that contains the metadata useful for decoding

Returns:

the new instance

encode

public Object encode(Object o)

encode the type safe java object into the corresponding DBObject

Parameters:

o - The object to encode

Returns:

the encoded version of the object

encode

public Object encode(Class c,
                     Object o)

encode the type safe java object into the corresponding DBObject

Parameters:

c - The type to use when encoding

o - The object to encode

Returns:

the encoded version of the object

fromDBObject

public void fromDBObject(DBObject dbObj,
                         MappedField mf,
                         Object targetEntity)

Creates an entity and populates its state based on the dbObject given. This method is primarily an internal method. Reliance on this method may break your application in future releases.

Parameters:

dbObj - the object state to use

mf - the MappedField containing the metadata to use when decoding in to a field

targetEntity - then entity to hold the state from the database

hasDbObjectConverter

public boolean hasDbObjectConverter(MappedField field)

Parameters:

field - the field to check with

Returns:

true if there is a converter for the type of the field

hasDbObjectConverter

public boolean hasDbObjectConverter(Class c)

Parameters:

c - the type to check

Returns:

true if there is a converter for the type

hasSimpleValueConverter

public boolean hasSimpleValueConverter(Object o)

Parameters:

o - the object/type to check

Returns:

true if there is a SimpleValueConverter for the type represented by o

See Also:

SimpleValueConverter

hasSimpleValueConverter

public boolean hasSimpleValueConverter(Class c)

Parameters:

c - the type to check

Returns:

true if there is a SimpleValueConverter for the type represented by c

See Also:

SimpleValueConverter

hasSimpleValueConverter

public boolean hasSimpleValueConverter(MappedField c)

Parameters:

c - the type to check

Returns:

true if there is a SimpleValueConverter for the type represented by c

See Also:

SimpleValueConverter

isRegistered

public boolean isRegistered(Class<? extends TypeConverter> tcClass)

Parameters:

tcClass - the type to check

Returns:

true if a converter of this type has been registered

removeConverter

public void removeConverter(TypeConverter tc)

Removes the type converter.

Parameters:

tc - the converter to remove

toDBObject

public void toDBObject(Object containingObject,
                       MappedField mf,
                       DBObject dbObj,
                       MapperOptions opts)

Converts an entity to a DBObject

Parameters:

containingObject - The object to convert

mf - the MappedField to extract

dbObj - the DBObject to populate

opts - the options to apply

getEncoder

protected TypeConverter getEncoder(Class c)

getEncoder

protected TypeConverter getEncoder(Object val,
                                   MappedField mf)