org.dizitart.no2.mapper

Interface NitriteMapper

All Known Implementing Classes:

AbstractMapper, JacksonMapper

public interface NitriteMapper

Represents an object mapper for nitrite database. It converts an object into a Nitrite Document.

Since:

1.0

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.
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

Method Detail

asDocument

<T> Document asDocument(T object)

Converts and object to a Document.

Type Parameters:

T - the type parameter

Parameters:

object - the object

Returns:

the document

Throws:

ObjectMappingException - if circular reference found.

asObject

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

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

Type Parameters:

T - the type parameter

Parameters:

document - the document

type - the type of the object

Returns:

the object

Throws:

java.lang.IllegalArgumentException - if conversion fails due to incompatible type.

ObjectMappingException - if no public parameter-less constructor found.

isValueType

boolean isValueType(java.lang.Object object)

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

Parameters:

object - the object to check

Returns:

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

asValue

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

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.

Parameters:

object - the object to convert

Returns:

the object as a value type.

parse

Document parse(java.lang.String json)

Parses a json string into a nitrite Document.

Parameters:

json - the json string to parse

Returns:

the document

toJson

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

Serializes an object to a json string

Parameters:

object - the object

Returns:

the json string