ReferenceConverter (Morphia)

java.lang.Object
- dev.morphia.converters.TypeConverter
- - dev.morphia.converters.experimental.ReferenceConverter

```
public class ReferenceConverter
extends TypeConverter
```
A converter for MorphiaReference values

See Also:

MorphiaReference

Developer note. This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

Constructor Summary

Constructors
Constructor Description

ReferenceConverter(Mapper mapper)
Creates the Converter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Object`	`decode(java.lang.Class<?> targetClass, java.lang.Object idValue, MappedField optionalExtraInfo)`	decode the `DBObject` and provide the corresponding java (type-safe) object NOTE: optionalExtraInfo might be null
`java.lang.Object`	`encode(java.lang.Object value, MappedField optionalExtraInfo)`	encode the (type-safe) java object into the corresponding `DBObject`

Methods inherited from class dev.morphia.converters.TypeConverter
decode, encode, equals, getMapper, getSupportTypes, hashCode, isSupported, oneOf, oneOfClasses, setMapper, setSupportedTypes, setSupportTypes

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReferenceConverter
```
public ReferenceConverter(Mapper mapper)
```
    Creates the Converter.
    
    Parameters:
    
    mapper - the mapper
- Method Detail
  - encode
```
public java.lang.Object encode(java.lang.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
  - decode
```
public java.lang.Object decode(java.lang.Class<?> targetClass,
                               java.lang.Object idValue,
                               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
    
    idValue - the DBObject to use when populating the new instance
    
    optionalExtraInfo - the MappedField that contains the metadata useful for decoding
    
    Returns:
    
    the new instance