net.endrealm.realmdrive.interfaces

Interface ConversionHandler

All Known Implementing Classes:

SimpleConversionHandler

public interface ConversionHandler

Author:

johannesjumpertz Defines a realm drive conversion handler. Class is used to translate Java objects into Driver Objects

Method Summary

Modifier and Type	Method and Description
List	createList(DriveElementArray array, Class clazz, Object parent) Creates a new list with the given class
void	registerClasses(Class<?>... classes) Register classes used for conversion.
void	registerSerializers(CustomSerializer... serializers) Register serializers used to convert complex endpoints to database values.
void	setService(DriveService service) Sets the service the reader is used by.
<T> T	transform(DriveObject statisticsObject, Class<T> clazz) Transforms a stats object into a classes object.
DriveObject	transform(Object object) Transforms a basic object into a DriveObject.
Object	transformAutomatically(DriveObject statisticsObject) Tries to automatically transform the statistics object into a registered one

Method Detail

registerClasses

void registerClasses(Class<?>... classes)

Register classes used for conversion.

Parameters:

classes - the classes to be added. Class should contain at least one field marked with SaveVar

registerSerializers

void registerSerializers(CustomSerializer... serializers)

Register serializers used to convert complex endpoints to database values. Priority follows LiFo, last elements will be prioritised

Parameters:

serializers - the serializers to add

transform

<T> T transform(DriveObject statisticsObject,
                Class<T> clazz)

Transforms a stats object into a classes object. Target class must be registered.

Type Parameters:

T - type of target

Parameters:

statisticsObject - the object to convert

clazz - target clazz to convert to

Returns:

returns instance of target type

Throws:

ClassCastException - if object can not be transformed.

createList

List createList(DriveElementArray array,
                Class clazz,
                Object parent)

Creates a new list with the given class

Parameters:

array - array to transform

clazz - target clazz

parent - optional parent instance

Returns:

the list

Throws:

ClassCastException - thrown when two lists are in one another

transform

DriveObject transform(Object object)

Transforms a basic object into a DriveObject. This does not work for primitives. Class must be registered.

Parameters:

object - object to transform

Returns:

transformed object

Throws:

ClassCastException - thrown when object can not be transformed

transformAutomatically

Object transformAutomatically(DriveObject statisticsObject)

Tries to automatically transform the statistics object into a registered one

Parameters:

statisticsObject - object to be transformed

Returns:

null if element does not contain a className or registered class isn't found

setService

void setService(DriveService service)

Sets the service the reader is used by.

Parameters:

service - service the reader is used by