rename deserialize to deserializePluginInfo & docs

lavalink-devs · Oct 12, 2023 · 83128ee · 83128ee
1 parent 62d03df
commit 83128ee
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/protocol/src/commonMain/kotlin/dev/arbjerg/lavalink/protocol/v4/loadResult.kt b/protocol/src/commonMain/kotlin/dev/arbjerg/lavalink/protocol/v4/loadResult.kt
@@ -136,7 +136,17 @@ data class Playlist(
     val pluginInfo: JsonObject,
     val tracks: List<Track>
 ) : LoadResult.Data {
-    fun <T> deserialize(deserializer: DeserializationStrategy<T>): T = pluginInfo.deserialize(deserializer)
+
+    /**
+     * Deserialize the plugin info into a specific type.
+     * This method is a convenience method meant to be used in Java,
+     * since Kotlin extension methods are painful to use in Java.
+     *
+     * @param deserializer The deserializer to use. (e.g. `T.Companion.serializer()`)
+     *
+     * @return the deserialized plugin info as type T
+     */
+    fun <T> deserializePluginInfo(deserializer: DeserializationStrategy<T>): T = pluginInfo.deserialize(deserializer)
 }
 
 @Serializable

diff --git a/protocol/src/commonMain/kotlin/dev/arbjerg/lavalink/protocol/v4/player.kt b/protocol/src/commonMain/kotlin/dev/arbjerg/lavalink/protocol/v4/player.kt
@@ -33,7 +33,17 @@ data class Track(
     val info: TrackInfo,
     val pluginInfo: JsonObject
 ) : LoadResult.Data {
-    fun <T> deserialize(deserializer: DeserializationStrategy<T>): T = pluginInfo.deserialize(deserializer)
+
+    /**
+     * Deserialize the plugin info into a specific type.
+     * This method is a convenience method meant to be used in Java,
+     * since Kotlin extension methods are painful to use in Java.
+     *
+     * @param deserializer The deserializer to use. (e.g. `T.Companion.serializer()`)
+     *
+     * @return the deserialized plugin info as type T
+     */
+    fun <T> deserializePluginInfo(deserializer: DeserializationStrategy<T>): T = pluginInfo.deserialize(deserializer)
 }
 
 @Serializable