org.dizitart.no2.internals

Class JacksonMapper

java.lang.Object

org.dizitart.no2.internals.JacksonMapper

All Implemented Interfaces:

NitriteMapper

public class JacksonMapper
extends java.lang.Object
implements NitriteMapper

A jackson based NitriteMapper implementation. It uses jackson’s ObjectMapper to convert an object into a Nitrite Document.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
JacksonMapper()

Method Summary

Modifier and Type	Method and Description
<T> Document	asDocument(T object) Converts and object to a Document.
<T> T	asObject(Document document, java.lang.Class<T> type) Tries to convert a document to an object of type T.
java.lang.Object	asValue(java.lang.Object object) Tries to convert an object to a value type, which will be stored in the document.
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper() Gets the underlying ObjectMapper instance to configure.
boolean	isValueType(java.lang.Object object) Determines if an object would be stored as a value type.
Document	parse(java.lang.String json) Parses a json string into a nitrite Document.
java.lang.String	toJson(java.lang.Object object) Serializes an object to a json string

Methods inherited from class java.lang.Object

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

Constructor Detail

JacksonMapper

public JacksonMapper()

Method Detail

asDocument

public <T> Document asDocument(T object)

Description copied from interface: NitriteMapper

Converts and object to a Document.

Specified by:

asDocument in interface NitriteMapper

Type Parameters:

T - the type parameter

Parameters:

object - the object

Returns:

the document

asObject

public <T> T asObject(Document document,
                      java.lang.Class<T> type)

Description copied from interface: NitriteMapper

Tries to convert a document to an object of type T.

Specified by:

asObject in interface NitriteMapper

Type Parameters:

T - the type parameter

Parameters:

document - the document

type - the type of the object

Returns:

the object

isValueType

public boolean isValueType(java.lang.Object object)

Description copied from interface: NitriteMapper

Determines if an object would be stored as a value type.

Specified by:

isValueType in interface NitriteMapper

Parameters:

object - the object to check

Returns:

true of object would be stored as a value type; false otherwise.

asValue

public java.lang.Object asValue(java.lang.Object object)

Description copied from interface: NitriteMapper

Tries to convert an object to a value type, which will be stored in the document.

As an example, a Date object is stored as a Long value in the document. This operation will return the long value of a Date object.

Specified by:

asValue in interface NitriteMapper

Parameters:

object - the object to convert

Returns:

the object as a value type.

parse

public Document parse(java.lang.String json)

Description copied from interface: NitriteMapper

Parses a json string into a nitrite Document.

Specified by:

parse in interface NitriteMapper

Parameters:

json - the json string to parse

Returns:

the document

toJson

public java.lang.String toJson(java.lang.Object object)

Description copied from interface: NitriteMapper

Serializes an object to a json string

Specified by:

toJson in interface NitriteMapper

Parameters:

object - the object

Returns:

the json string

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Gets the underlying ObjectMapper instance to configure.

Returns:

the object mapper instance.