net.malisis.core.util.syncer

Class Syncer

java.lang.Object

net.malisis.core.util.syncer.Syncer

public class Syncer
extends java.lang.Object

This class handles the synchronization between server and client objects. Objects to be synchronized need to have the Syncable annotation on their classes with a value matching a registered ISyncHandler.
Fields that need to be synchronized need Sync annotation.
To manually synchronize one or more fields, call sync(Object, String...) with the Sync values for those fields.

Method Summary

Modifier and Type	Method and Description
static void	autoSync(java.lang.Object caller)
void	discover(net.minecraftforge.fml.common.discovery.ASMDataTable asmDataTable) Discovers all the classes with Syncable annotation and fields with Sync annotation.
static Syncer	get() Gets the Syncer instance.
<T> ISyncHandler<? super T,? extends ISyncableData>	getHandler(T caller) Gets the ISyncHandler for the specified object.
ISyncHandler<?,? extends ISyncableData>	getHandlerFromId(int id) Gets a ISyncHandler from it's ID
int	getHandlerId(ISyncHandler<?,? extends ISyncableData> handler) Gets the handler id for the specified ISyncHandler.
static void	registerHandler(ISyncHandler<?,? extends ISyncableData> handler) Registers a ISyncHandler to the Syncer.
static void	sync(java.lang.Object caller, java.lang.String... syncNames) Synchronizes the specified fields names and sends the corresponding packet.
void	updateValues(java.lang.Object receiver, ISyncHandler<?,? extends ISyncableData> handler, java.util.Map<java.lang.String,java.lang.Object> values) Update the fields values for the receiver object.

Methods inherited from class java.lang.Object

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

Method Detail

getHandlerId

public int getHandlerId(ISyncHandler<?,? extends ISyncableData> handler)

Gets the handler id for the specified ISyncHandler.

Parameters:

handler - the handler

Returns:

the handler id

getHandlerFromId

public ISyncHandler<?,? extends ISyncableData> getHandlerFromId(int id)

Gets a ISyncHandler from it's ID

Parameters:

id - the id

Returns:

the handler from id

getHandler

public <T> ISyncHandler<? super T,? extends ISyncableData> getHandler(T caller)

Gets the ISyncHandler for the specified object.

Type Parameters:

T - the generic type

Parameters:

caller - the caller

Returns:

the handler

discover

public void discover(net.minecraftforge.fml.common.discovery.ASMDataTable asmDataTable)

Discovers all the classes with Syncable annotation and fields with Sync annotation.
Fields are added the the corresponding ISyncHandler.

Parameters:

asmDataTable - the asm data table

updateValues

public void updateValues(java.lang.Object receiver,
                         ISyncHandler<?,? extends ISyncableData> handler,
                         java.util.Map<java.lang.String,java.lang.Object> values)

Update the fields values for the receiver object.

Parameters:

receiver - the caller

handler - the handler

values - the values

get

public static Syncer get()

Gets the Syncer instance.

Returns:

the syncer

registerHandler

public static void registerHandler(ISyncHandler<?,? extends ISyncableData> handler)

Registers a ISyncHandler to the Syncer.

Parameters:

handler - the handler

sync

public static void sync(java.lang.Object caller,
                        java.lang.String... syncNames)

Synchronizes the specified fields names and sends the corresponding packet.

Parameters:

caller - the caller

syncNames - the sync names

autoSync

public static void autoSync(java.lang.Object caller)