buildcraft.core.network.serializers

Class ClassMapping

java.lang.Object

buildcraft.core.network.serializers.ClassSerializer

buildcraft.core.network.serializers.ClassMapping

public class ClassMapping
extends ClassSerializer

This class implements custom class mapping. There are three advantages in using a custom serializer here: (1) the approach is constructive instead of destructive, that is to say, only marked fields will be taken. Granted, this is mostly coding style related, but this prevent introduction of useless serialized data by mistake. (2) we can introduce specific serialized types. For example (although not yet implemented?) we will be able to implement a tile as a reference to this tile through e.g. {x, y, z}, that is know what needs to be serialized, know what needs to be referenced, and how to reference it. (3) again, not yet implemented, but we can in theory have different set of serialization depending on the context. HISTORY NOTE This was initially developed because the initial network framework only allowed for byte, float and int, so more things were needed. To the light of current understanding, using only byte would have been good enough. It seems like the three points above indeed give more value and safety to the whole code and make this system still relevant. To be re-evaluated. QUESTION ON OBJECTS At the moment, we do not support object creation from this interface, so the objects are supposed to be already there and then updated. This may not always make sense, in particular in the context of RPC Non-null arrays of objects are forbidden as well, and they need to be set to the same null and non-null elements on both sides.

Field Summary

Fields inherited from class buildcraft.core.network.serializers.ClassSerializer

mappedClass

Constructor Summary

Constructors

Constructor and Description
ClassMapping()

Method Summary

Methods

Modifier and Type	Method and Description
void	analyzeClass(java.lang.Class<? extends java.lang.Object> c)
static ClassSerializer	get(java.lang.Class clas)
java.lang.Object	read(io.netty.buffer.ByteBuf data, java.lang.Object o, SerializationContext context)
void	write(io.netty.buffer.ByteBuf data, java.lang.Object o, SerializationContext context) This class will update data in an object from a stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassMapping

public ClassMapping()

Method Detail

analyzeClass

public void analyzeClass(java.lang.Class<? extends java.lang.Object> c)

write

public void write(io.netty.buffer.ByteBuf data,
         java.lang.Object o,
         SerializationContext context)
           throws java.lang.IllegalArgumentException,
                  java.lang.IllegalAccessException

This class will update data in an object from a stream. Public data market #NetworkData will get synchronized. The following rules will apply: In the following description, we consider strings as primitive objects. Market primitives data will be directly updated on the destination object after the value of the source object Market primitive arrays will be re-created in the destination object after the primitive array of the source object. This means that array references are not preserved by the proccess. If an array is null in the source array and not in the destination one, it will be turned to null. Market object will be synchronized - that it we do not create new instances in the destination object if they are already there but rather recursively synchronize values. If destination is null and not source, the destination will get the instance created. If destination is not null and source is, the destination will get truned to null. Market object arrays will be synchronized - not re-created. If destination is null and not source, the destination will get the instance created. If destination is not null and source is, the destination will get turned to null. The same behavior applies to the contents of the array. Trying to synchronize two arrays of different size is an error and will lead to an exception - so if the array needs to change on the destination it needs to be set to null first. WARNINGS - only public non-final fields can be serialized - non static nested classes are not supported - no reference analysis is done, e.g. an object referenced twice will be serialized twice

Specified by:

write in class ClassSerializer

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

read

public java.lang.Object read(io.netty.buffer.ByteBuf data,
                    java.lang.Object o,
                    SerializationContext context)
                      throws java.lang.IllegalArgumentException,
                             java.lang.IllegalAccessException,
                             java.lang.InstantiationException,
                             java.lang.ClassNotFoundException

Specified by:

read in class ClassSerializer

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.InstantiationException

java.lang.ClassNotFoundException

get

public static ClassSerializer get(java.lang.Class clas)