org.mongodb.morphia.converters

Class TypeConverter

java.lang.Object

org.mongodb.morphia.converters.TypeConverter

Direct Known Subclasses:

BooleanConverter, ByteConverter, CharacterConverter, CharArrayConverter, ClassConverter, DateConverter, DoubleConverter, EnumConverter, EnumSetConverter, FloatConverter, GeometryConverter, GeometryQueryConverter, GeometryShapeConverter, IdentityConverter, IntegerConverter, IterableConverter, KeyConverter, LocaleConverter, LongConverter, MapOfValuesConverter, NamedCoordinateReferenceSystemConverter, ObjectIdConverter, SerializedObjectConverter, ShortConverter, StringConverter, URIConverter, UUIDConverter

public abstract class TypeConverter
extends Object

Author:

Uwe Schaefer, (us@thomas-daily.de)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TypeConverter()
protected	TypeConverter(Class... types)

Method Summary

Modifier and Type	Method and Description
abstract Object	decode(Class<?> targetClass, Object fromDBObject, MappedField optionalExtraInfo) decode the DBObject and provide the corresponding java (type-safe) object NOTE: optionalExtraInfo might be null
Object	decode(Class targetClass, Object fromDBObject) decode the DBObject and provide the corresponding java (type-safe) object
Object	encode(Object value) encode the type safe java object into the corresponding DBObject
Object	encode(Object value, MappedField optionalExtraInfo) encode the (type-safe) java object into the corresponding DBObject
boolean	equals(Object obj)
Mapper	getMapper()
Class[]	getSupportTypes() Deprecated. use #getSupportedTypes()
int	hashCode()
protected boolean	isSupported(Class<?> c, MappedField optionalExtraInfo) checks if the class is supported for this converter.
protected boolean	oneOf(Class f, Class... classes) checks if Class f is in classes *
protected boolean	oneOfClasses(Class f, Class[] classes) checks if Class f is in classes *
void	setMapper(Mapper mapper) Sets the Mapper to use.
void	setSupportedTypes(Class[] supportedTypes) Sets the types supported by this converter.
void	setSupportTypes(Class[] supportTypes) Deprecated. use #setSupportedTypes(Class[])

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeConverter

protected TypeConverter()

TypeConverter

protected TypeConverter(Class... types)

Method Detail

decode

public final Object decode(Class targetClass,
                           Object fromDBObject)

decode the DBObject and provide the corresponding java (type-safe) object

Parameters:

targetClass - the class to create and populate

fromDBObject - the DBObject to use when populating the new instance

Returns:

the new instance

decode

public abstract Object decode(Class<?> targetClass,
                              Object fromDBObject,
                              MappedField optionalExtraInfo)

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

Parameters:

targetClass - the class to create and populate

fromDBObject - the DBObject to use when populating the new instance

optionalExtraInfo - the MappedField that contains the metadata useful for decoding

Returns:

the new instance

encode

public final Object encode(Object value)

encode the type safe java object into the corresponding DBObject

Parameters:

value - The object to encode

Returns:

the encoded version of the object

encode

public Object encode(Object value,
                     MappedField optionalExtraInfo)

encode the (type-safe) java object into the corresponding DBObject

Parameters:

value - The object to encode

optionalExtraInfo - the MappedField that contains the metadata useful for decoding

Returns:

the encoded version of the object

getMapper

public Mapper getMapper()

Returns:

the mapper used by the converter

setMapper

public void setMapper(Mapper mapper)

Sets the Mapper to use.

Parameters:

mapper - the Mapper to use

getSupportTypes

@Deprecated
public Class[] getSupportTypes()

Deprecated. use #getSupportedTypes()

Returns:

an array of supported convertable types

setSupportTypes

@Deprecated
public void setSupportTypes(Class[] supportTypes)

Deprecated. use #setSupportedTypes(Class[])

Parameters:

supportTypes - the types this converter supports

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isSupported

protected boolean isSupported(Class<?> c,
                              MappedField optionalExtraInfo)

checks if the class is supported for this converter.

oneOf

protected boolean oneOf(Class f,
                        Class... classes)

checks if Class f is in classes *

oneOfClasses

protected boolean oneOfClasses(Class f,
                               Class[] classes)

checks if Class f is in classes *

setSupportedTypes

public void setSupportedTypes(Class[] supportedTypes)

Sets the types supported by this converter.

Parameters:

supportedTypes - the types this converter supports