jakarta.nosql.mapping.document

Interface DocumentEntityConverter

public interface DocumentEntityConverter

This interface represents the converter between an entity and the DocumentEntity

Method Summary

Modifier and Type	Method and Description
DocumentEntity	toDocument(Object entityInstance) Converts the instance entity to DocumentEntity
<T> T	toEntity(Class<T> entityClass, DocumentEntity entity) Converts a DocumentEntity to entity
<T> T	toEntity(DocumentEntity entity) Similar to toEntity(Class, DocumentEntity), but search the instance type from DocumentEntity.getName()
<T> T	toEntity(T entityInstance, DocumentEntity entity) Converts a DocumentEntity to entity Instead of creating a new object is uses the instance used in this parameters

Method Detail

toDocument

DocumentEntity toDocument(Object entityInstance)

Converts the instance entity to DocumentEntity

Parameters:

entityInstance - the instnace

Returns:

a DocumentEntity instance

Throws:

NullPointerException - when entityInstance is null

toEntity

<T> T toEntity(Class<T> entityClass,
               DocumentEntity entity)

Converts a DocumentEntity to entity

Type Parameters:

T - the entity type

Parameters:

entityClass - the entity class

entity - the DocumentEntity to be converted

Returns:

the instance from DocumentEntity

Throws:

NullPointerException - when either entityClass or entity are null

toEntity

<T> T toEntity(T entityInstance,
               DocumentEntity entity)

Converts a DocumentEntity to entity Instead of creating a new object is uses the instance used in this parameters

Type Parameters:

T - the entity type

Parameters:

entityInstance - the entity class

entity - the DocumentEntity to be converted

Returns:

the instance from DocumentEntity

Throws:

NullPointerException - when either entityInstance or entity are null

toEntity

<T> T toEntity(DocumentEntity entity)

Similar to toEntity(Class, DocumentEntity), but search the instance type from DocumentEntity.getName()

Type Parameters:

T - the entity type

Parameters:

entity - the DocumentEntity to be converted

Returns:

the instance from DocumentEntity

Throws:

NullPointerException - when entity is null