com.bonzaiengine.serialize.api

Interface ISerializer<T>

public interface ISerializer<T>

Method Summary

Modifier and Type	Method and Description
T	alloc(java.util.Map<java.lang.String,java.lang.String> attributes, Serializer.IFieldAccess parentFieldSetter, java.lang.String fieldName)
java.util.Map<java.lang.String,java.lang.String>	getAttributes(T src)
java.lang.Object	getField(T src, java.lang.String fieldName)
java.lang.String	getFieldName(int index)
java.lang.Class<?>	getFieldType(int index)
int	getNumFields()
java.lang.Class<T>	getSerializeClass()
java.lang.String	getSerializeType()
boolean	isDefaultValue(java.lang.String fieldName, java.lang.Object fieldValue)
boolean	isFieldActive(java.lang.String fieldName)
boolean	setField(T dst, java.lang.String fieldName, java.lang.Object fieldValue)
void	setFieldActive(java.lang.String fieldName, boolean active)

Method Detail

getSerializeClass

java.lang.Class<T> getSerializeClass()

Returns:

the Class representing the object serialized by this ISerializer

getSerializeType

java.lang.String getSerializeType()

Returns:

by default getSerializeClass().getName(), but the implementation may choose another unique identifier

alloc

T alloc(java.util.Map<java.lang.String,java.lang.String> attributes,
        Serializer.IFieldAccess parentFieldSetter,
        java.lang.String fieldName)
 throws java.lang.Exception

Parameters:

value - the value returned by getField(Object, String) with field name being null

parentFieldSetter - FIXME [serializer] api hack for GameObjectIO

fieldName - FIXME [serializer] api hack for GameObjectIO

Returns:

the new object allocated

Throws:

java.lang.Exception - in case of error during allocation

getNumFields

int getNumFields()

Returns:

the number of fields

getFieldType

java.lang.Class<?> getFieldType(int index)

getFieldName

java.lang.String getFieldName(int index)

getAttributes

java.util.Map<java.lang.String,java.lang.String> getAttributes(T src)

Parameters:

src - an Object to get the attributes

Returns:

Map containing the list of attributes for the specified object

getField

java.lang.Object getField(T src,
                          java.lang.String fieldName)

Parameters:

src - an Object to get the specified field name value

fieldName - a field name, or null to get the value specified as parameter of #alloc(String, IFieldAccess, String)

Returns:

the requested value

setField

boolean setField(T dst,
                 java.lang.String fieldName,
                 java.lang.Object fieldValue)
          throws java.lang.Exception

Parameters:

dst - an Object to set the specified field name value

fieldName - the field name to set, could not be null

fieldValue - the field value to set to the associated name

Returns:

true if succeed

Throws:

java.lang.Exception - in case of unexpected error

isDefaultValue

boolean isDefaultValue(java.lang.String fieldName,
                       java.lang.Object fieldValue)

Parameters:

fieldName - a field name

fieldValue - a value associated to the field name

Returns:

true if the value specified is the default value associated to the corresponding name

setFieldActive

void setFieldActive(java.lang.String fieldName,
                    boolean active)

isFieldActive

boolean isFieldActive(java.lang.String fieldName)