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

Changed method signatures to require non-null

This commit is contained in:
Robinson 2021-08-18 17:34:33 -06:00
parent 91ea197a0c
commit 3a32ca7678
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/dorkbox/serializers/SerializationManager.kt
View File

@ -32,7 +32,7 @@ interface SerializationManager<IO> {
* 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 order classes are registered is important when using this
* method. The order must be the same at deserialization as it was for serialization. * method. The order must be the same at deserialization as it was for serialization.
*/ */
fun <T> register(clazz: Class<T>?): SerializationManager<*>? fun <T> register(clazz: Class<T>): SerializationManager<*>
/** /**
* 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 * 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
@ -47,7 +47,7 @@ interface SerializationManager<IO> {
* @param id Must be >= 0. Smaller IDs are serialized more efficiently. IDs 0-8 are used by default for primitive types and String, but * @param id Must be >= 0. Smaller IDs are serialized more efficiently. IDs 0-8 are used by default for primitive types and String, but
* these IDs can be repurposed. * these IDs can be repurposed.
*/ */
fun <T> register(clazz: Class<T>?, id: Int): SerializationManager<*>? fun <T> register(clazz: Class<T>, id: Int): SerializationManager<*>
/** /**
* Registers the class using the lowest, next available integer ID and the specified serializer. If the class is already registered, * Registers the class using the lowest, next available integer ID and the specified serializer. If the class is already registered,
@ -60,7 +60,7 @@ interface SerializationManager<IO> {
* 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 order classes are registered is important when using this
* method. The order must be the same at deserialization as it was for serialization. * method. The order must be the same at deserialization as it was for serialization.
*/ */
fun <T> register(clazz: Class<T>?, serializer: Serializer<T>?): SerializationManager<*>? fun <T> register(clazz: Class<T>, serializer: Serializer<T>): SerializationManager<*>
/** /**
* Registers the class using the specified ID and serializer. If the ID is already in use by the same type, the old entry 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
@ -75,12 +75,11 @@ interface SerializationManager<IO> {
* @param id Must be >= 0. Smaller IDs are serialized more efficiently. IDs 0-8 are used by default for primitive types and String, but * @param id Must be >= 0. Smaller IDs are serialized more efficiently. IDs 0-8 are used by default for primitive types and String, but
* these IDs can be repurposed. * these IDs can be repurposed.
*/ */
fun <T> register(clazz: Class<T>?, serializer: Serializer<T>?, id: Int): SerializationManager<*>? fun <T> register(clazz: Class<T>, serializer: Serializer<T>, id: Int): SerializationManager<*>
/** /**
* Waits until a kryo is available to write, using CAS operations to prevent having to synchronize. * Waits until a kryo is available to write, using CAS operations to prevent having to synchronize.
* *
*
* There is a small speed penalty if there were no kryo's available to use. * There is a small speed penalty if there were no kryo's available to use.
*/ */
@Throws(IOException::class) @Throws(IOException::class)
@ -98,11 +97,11 @@ interface SerializationManager<IO> {
* Writes the class and object using an available kryo instance * Writes the class and object using an available kryo instance
*/ */
@Throws(IOException::class) @Throws(IOException::class)
fun writeFullClassAndObject(output: Output?, value: Any?) fun writeFullClassAndObject(output: Output, value: Any?)
/** /**
* Returns a class read from the input * Returns a class read from the input
*/ */
@Throws(IOException::class) @Throws(IOException::class)
fun readFullClassAndObject(input: Input?): Any? fun readFullClassAndObject(input: Input): Any?
} }