org.mongodb.morphia.converters

Class EnumConverter

java.lang.Object

org.mongodb.morphia.converters.TypeConverter

org.mongodb.morphia.converters.EnumConverter

All Implemented Interfaces:

SimpleValueConverter

public class EnumConverter
extends TypeConverter
implements SimpleValueConverter

Author:

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

Constructor Summary

Constructors

Constructor and Description
EnumConverter()

Method Summary

Modifier and Type	Method and Description
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	encode(Object value, MappedField optionalExtraInfo) encode the (type-safe) java object into the corresponding DBObject
protected boolean	isSupported(Class c, MappedField optionalExtraInfo) checks if the class is supported for this converter.

Methods inherited from class org.mongodb.morphia.converters.TypeConverter

decode, encode, equals, getMapper, getSupportTypes, hashCode, oneOf, oneOfClasses, setMapper, setSupportedTypes, setSupportTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumConverter

public EnumConverter()

Method Detail

decode

public Object decode(Class targetClass,
                     Object fromDBObject,
                     MappedField optionalExtraInfo)

Description copied from class: TypeConverter

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

Specified by:

decode in class TypeConverter

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 Object encode(Object value,
                     MappedField optionalExtraInfo)

Description copied from class: TypeConverter

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

Overrides:

encode in class TypeConverter

Parameters:

value - The object to encode

optionalExtraInfo - the MappedField that contains the metadata useful for decoding

Returns:

the encoded version of the object

isSupported

protected boolean isSupported(Class c,
                              MappedField optionalExtraInfo)

Description copied from class: TypeConverter

checks if the class is supported for this converter.

Overrides:

isSupported in class TypeConverter