dorkbox/Utilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

JavaDoc polish

Browse Source
This commit is contained in:
nathan 2018-01-14 00:20:54 +01:00
parent 5618d6bee1
commit c824a7f8a9
1 changed files with 24 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
src/dorkbox/util/SerializationManager.java
View File

@ -30,55 +30,50 @@ public
interface SerializationManager { interface SerializationManager {
/** /**
* Registers the class using the lowest, next available integer ID and the * Registers the class using the lowest, next available integer ID and the {@link Kryo#getDefaultSerializer(Class) default serializer}.
* {@link Kryo#getDefaultSerializer(Class) default serializer}. If the class * If the class is already registered, the existing entry is updated with the new serializer.
* is already registered, the existing entry is updated with the new * <p>
* serializer. Registering a primitive also affects the corresponding * Registering a primitive also affects the corresponding primitive wrapper.
* primitive wrapper. * <p>
* <p/> * Because the ID assigned is affected by the IDs registered before it, the order classes are registered is important when using this
* Because the ID assigned is affected by the IDs registered before it, the * method. The order must be the same at deserialization as it was for serialization.
* order classes are registered is important when using this method. The
* order must be the same at deserialization as it was for serialization.
*/ */
SerializationManager register(Class<?> clazz); SerializationManager register(Class<?> clazz);
/** /**
* Registers the class using the specified ID. If the ID is * Registers the class using the specified ID. If the ID is already in use by the same type, the old entry is overwritten. If the ID
* already in use by the same type, the old entry is overwritten. If the ID
* is already in use by a different type, a {@link KryoException} is thrown. * is already in use by a different type, a {@link KryoException} is thrown.
* <p>
* Registering a primitive also affects the corresponding primitive wrapper. * Registering a primitive also affects the corresponding primitive wrapper.
* <p/> * <p>
* IDs must be the same at deserialization as they were for serialization. * IDs must be the same at deserialization as they were for serialization.
* *
* @param id Must be >= 0. Smaller IDs are serialized more efficiently. IDs * @param id Must be >= 0. Smaller IDs are serialized more efficiently. IDs 0-8 are used by default for primitive types and String, but
* 0-8 are used by default for primitive types and String, but
* these IDs can be repurposed. * these IDs can be repurposed.
*/ */
SerializationManager register(Class<?> clazz, int id); SerializationManager register(Class<?> clazz, int id);
/** /**
* Registers the class using the lowest, next available integer ID and the * Registers the class using the lowest, next available integer ID and the specified serializer. If the class is already registered,
* specified serializer. If the class is already registered, the existing * the existing entry is updated with the new serializer.
* entry is updated with the new serializer. Registering a primitive also * <p>
* affects the corresponding primitive wrapper. * Registering a primitive also affects the corresponding primitive wrapper.
* <p/> * <p>
* Because the ID assigned is affected by the IDs registered before it, the * Because the ID assigned is affected by the IDs registered before it, the order classes are registered is important when using this
* order classes are registered is important when using this method. The * method. The order must be the same at deserialization as it was for serialization.
* order must be the same at deserialization as it was for serialization.
*/ */
SerializationManager register(Class<?> clazz, Serializer<?> serializer); SerializationManager register(Class<?> clazz, Serializer<?> serializer);
/** /**
* Registers the class using the specified ID and serializer. If the ID is * Registers the class using the specified ID and serializer. If the ID is already in use by the same type, the old entry is
* already in use by the same type, the old entry is overwritten. If the ID * overwritten. If the ID is already in use by a different type, a {@link KryoException} is thrown.
* is already in use by a different type, a {@link KryoException} is thrown. * <p>
* Registering a primitive also affects the corresponding primitive wrapper. * Registering a primitive also affects the corresponding primitive wrapper.
* <p/> * <p>
* IDs must be the same at deserialization as they were for serialization. * IDs must be the same at deserialization as they were for serialization.
* *
* @param id Must be >= 0. Smaller IDs are serialized more efficiently. IDs * @param id Must be >= 0. Smaller IDs are serialized more efficiently. IDs 0-8 are used by default for primitive types and String, but
* 0-8 are used by default for primitive types and String, but * these IDs can be repurposed.
* these IDs can be repurposed.
*/ */
SerializationManager register(Class<?> clazz, Serializer<?> serializer, int id); SerializationManager register(Class<?> clazz, Serializer<?> serializer, int id);