net.sergeych.map_serializer

Class MapSerializer

java.lang.Object

net.sergeych.map_serializer.MapSerializer

public class MapSerializer
extends java.lang.Object

Serializes and deserializes any class to Map. Intended to use with protocols like JSON or BOSS. Supports aliasing for classes and fields SerialName and class names in maps.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MapSerializer.CantProcessException General error while serializing or deserializing

Field Summary

Fields

Modifier and Type	Field and Description
java.util.HashMap<java.lang.String,java.lang.Class<?>>	classAliases

Constructor Summary

Constructors

Constructor and Description
MapSerializer()

Method Summary

Modifier and Type	Method and Description
void	addClassAlias(java.lang.Class<?> cls, java.lang.String alias) Set the class name alias for the given Class.
static java.lang.String	camelToSnakeCase(java.lang.String camel) convert camelCaseString to snake_case_string
protected java.lang.Class<?>	classForName(java.lang.String name) Could be overriden to support more complicated class-to-name logic.
protected java.lang.String	className(java.lang.Class<?> cls) Could be overriden to support more complicated class-to-name logic.
java.lang.Object	fromMap(java.util.Map<java.lang.String,java.lang.Object> map) Instantiate object by its attributes map.
<T> T	fromMap(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.Class<T> cls) Instantiate object of a given Class and initialize it with attributes in a map.
java.lang.Object	fromMap(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.String className) Instantiate object with a given name and attributes map.
protected void	logicError(java.lang.Exception e)
void	registerPackage(java.lang.String packageName) Register all class aliases for a given package.
<T> T	setInstance(java.util.Map<java.lang.String,java.lang.Object> map, T object) Set object's fields from the map.
static java.lang.String	snakeToCamelCase(java.lang.String snake) Convert snake_case to camelCase
Binder	toMap(java.lang.Object object, boolean includeClass) Serialize some object to Map, using aliases if any.

Methods inherited from class java.lang.Object

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

Field Detail

classAliases

public java.util.HashMap<java.lang.String,java.lang.Class<?>> classAliases

Constructor Detail

MapSerializer

public MapSerializer()

Method Detail

registerPackage

public void registerPackage(java.lang.String packageName)
                     throws MapSerializer.CantProcessException

Register all class aliases for a given package. Should be called prior to any operation if class name aliases are used.

Parameters:

packageName - package name to include all aliased classes from.

Throws:

MapSerializer.CantProcessException

addClassAlias

public void addClassAlias(java.lang.Class<?> cls,
                          java.lang.String alias)

Set the class name alias for the given Class. Note that this works only with classes, not fields.

Parameters:

cls - class to create alias

alias -

toMap

public Binder toMap(java.lang.Object object,
                    boolean includeClass)
             throws MapSerializer.CantProcessException

Serialize some object to Map, using aliases if any.

Parameters:

object - what to serialize

includeClass - if true, will add "__class" key with object's class name or alias.

Returns:

serialized content.

Throws:

MapSerializer.CantProcessException

className

protected java.lang.String className(java.lang.Class<?> cls)

Could be overriden to support more complicated class-to-name logic. default implementation supports aliases from annotations or explicitly registered aliases or uses canonical name.

Parameters:

cls - class to find name for

Returns:

class name

classForName

protected java.lang.Class<?> classForName(java.lang.String name)
                                   throws java.lang.ClassNotFoundException

Could be overriden to support more complicated class-to-name logic. default implementation supports aliases from annotations or explicitly registered aliases or uses canonical name.

Parameters:

name - class name or alias

Returns:

Class for the given name

Throws:

java.lang.ClassNotFoundException

fromMap

public java.lang.Object fromMap(java.util.Map<java.lang.String,java.lang.Object> map)
                         throws MapSerializer.CantProcessException

Instantiate object by its attributes map. The map MUST contain "__class" key with a valid value.

Parameters:

map - class name and attributes map

Returns:

initialized object

Throws:

MapSerializer.CantProcessException

fromMap

public java.lang.Object fromMap(java.util.Map<java.lang.String,java.lang.Object> map,
                                java.lang.String className)
                         throws MapSerializer.CantProcessException

Instantiate object with a given name and attributes map.

Parameters:

map - instance attributes

className - class name or alias

Returns:

instantiated object

Throws:

MapSerializer.CantProcessException

fromMap

public <T> T fromMap(java.util.Map<java.lang.String,java.lang.Object> map,
                     java.lang.Class<T> cls)
              throws MapSerializer.CantProcessException

Instantiate object of a given Class and initialize it with attributes in a map.

Parameters:

map - attributes

cls - Class to instantiate

Returns:

T object

Throws:

MapSerializer.CantProcessException

setInstance

public <T> T setInstance(java.util.Map<java.lang.String,java.lang.Object> map,
                         T object)
                  throws MapSerializer.CantProcessException

Set object's fields from the map.

Parameters:

map - map with field values

object - object which fields will be filled

Returns:

object

Throws:

MapSerializer.CantProcessException

logicError

protected void logicError(java.lang.Exception e)
                   throws MapSerializer.CantProcessException

Throws:

MapSerializer.CantProcessException

snakeToCamelCase

public static java.lang.String snakeToCamelCase(java.lang.String snake)

Convert snake_case to camelCase

Parameters:

snake - snake_case_string

Returns:

camelCaseString

camelToSnakeCase

public static java.lang.String camelToSnakeCase(java.lang.String camel)

convert camelCaseString to snake_case_string

Parameters:

camel - camelString

Returns:

snake_string