Deprecate the toHex and toBase64 methods

ronhombre · Aug 28, 2024 · 3e541f5 · 3e541f5
1 parent 688d4f6
commit 3e541f5
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 0 deletions.
diff --git a/src/commonMain/kotlin/asia/hombre/kyber/KyberCipherText.kt b/src/commonMain/kotlin/asia/hombre/kyber/KyberCipherText.kt
@@ -130,6 +130,9 @@ class KyberCipherText internal constructor( //TODO: Copy parameter variables
      * @param isUppercase
      * @return [String]
      */
+    @Deprecated("Conversion to hex values are up to the user.", level = DeprecationLevel.WARNING, replaceWith =
+        ReplaceWith("fullBytes.toHexString(if (isUppercase) HexFormat.UpperCase else HexFormat.Default)")
+    )
     @OptIn(ExperimentalStdlibApi::class)
     override fun toHex(isUppercase: Boolean): String {
         return fullBytes.toHexString(if(isUppercase) HexFormat.UpperCase else HexFormat.Default)
@@ -140,6 +143,9 @@ class KyberCipherText internal constructor( //TODO: Copy parameter variables
      *
      * @return [String]
      */
+    @Deprecated("Conversion to base64 values are up to the user.", level = DeprecationLevel.WARNING,
+        replaceWith = ReplaceWith("Base64.encode(fullBytes)", "kotlin.io.encoding.Base64")
+    )
     @OptIn(ExperimentalEncodingApi::class)
     override fun toBase64(): String {
         return Base64.encode(fullBytes)

diff --git a/src/commonMain/kotlin/asia/hombre/kyber/KyberDecapsulationKey.kt b/src/commonMain/kotlin/asia/hombre/kyber/KyberDecapsulationKey.kt
@@ -141,6 +141,9 @@ class KyberDecapsulationKey internal constructor(
      * @param isUppercase
      * @return [String]
      */
+    @Deprecated("Conversion to hex values are up to the user.", level = DeprecationLevel.WARNING, replaceWith =
+        ReplaceWith("fullBytes.toHexString(if (isUppercase) HexFormat.UpperCase else HexFormat.Default)")
+    )
     @OptIn(ExperimentalStdlibApi::class)
     override fun toHex(isUppercase: Boolean): String {
         return fullBytes.toHexString(if(isUppercase) HexFormat.UpperCase else HexFormat.Default)
@@ -151,6 +154,9 @@ class KyberDecapsulationKey internal constructor(
      *
      * @return [String]
      */
+    @Deprecated("Conversion to base64 values are up to the user.", level = DeprecationLevel.WARNING,
+        replaceWith = ReplaceWith("Base64.encode(fullBytes)", "kotlin.io.encoding.Base64")
+    )
     @OptIn(ExperimentalEncodingApi::class)
     override fun toBase64(): String {
         return Base64.encode(fullBytes)

diff --git a/src/commonMain/kotlin/asia/hombre/kyber/KyberDecryptionKey.kt b/src/commonMain/kotlin/asia/hombre/kyber/KyberDecryptionKey.kt
@@ -122,6 +122,9 @@ class KyberDecryptionKey internal constructor(
      * @param isUppercase
      * @return [String]
      */
+    @Deprecated("Conversion to hex values are up to the user.", level = DeprecationLevel.WARNING, replaceWith =
+        ReplaceWith("fullBytes.toHexString(if (isUppercase) HexFormat.UpperCase else HexFormat.Default)")
+    )
     @OptIn(ExperimentalStdlibApi::class)
     override fun toHex(isUppercase: Boolean): String {
         return fullBytes.toHexString(if(isUppercase) HexFormat.UpperCase else HexFormat.Default)
@@ -132,6 +135,9 @@ class KyberDecryptionKey internal constructor(
      *
      * @return [String]
      */
+    @Deprecated("Conversion to base64 values are up to the user.", level = DeprecationLevel.WARNING,
+        replaceWith = ReplaceWith("Base64.encode(fullBytes)", "kotlin.io.encoding.Base64")
+    )
     @OptIn(ExperimentalEncodingApi::class)
     override fun toBase64(): String {
         return Base64.encode(fullBytes)

diff --git a/src/commonMain/kotlin/asia/hombre/kyber/KyberEncapsulationKey.kt b/src/commonMain/kotlin/asia/hombre/kyber/KyberEncapsulationKey.kt
@@ -107,6 +107,9 @@ class KyberEncapsulationKey internal constructor(
      * @param isUppercase
      * @return [String]
      */
+    @Deprecated("Conversion to hex values are up to the user.", level = DeprecationLevel.WARNING, replaceWith =
+        ReplaceWith("fullBytes.toHexString(if (isUppercase) HexFormat.UpperCase else HexFormat.Default)")
+    )
     @OptIn(ExperimentalStdlibApi::class)
     override fun toHex(isUppercase: Boolean): String {
         return fullBytes.toHexString(if(isUppercase) HexFormat.UpperCase else HexFormat.Default)
@@ -117,6 +120,9 @@ class KyberEncapsulationKey internal constructor(
      *
      * @return [String]
      */
+    @Deprecated("Conversion to base64 values are up to the user.", level = DeprecationLevel.WARNING,
+        replaceWith = ReplaceWith("Base64.encode(fullBytes)", "kotlin.io.encoding.Base64")
+    )
     @OptIn(ExperimentalEncodingApi::class)
     override fun toBase64(): String {
         return Base64.encode(fullBytes)

diff --git a/src/commonMain/kotlin/asia/hombre/kyber/KyberEncryptionKey.kt b/src/commonMain/kotlin/asia/hombre/kyber/KyberEncryptionKey.kt
@@ -136,6 +136,9 @@ class KyberEncryptionKey internal constructor(
      * @param isUppercase
      * @return [String]
      */
+    @Deprecated("Conversion to hex values are up to the user.", level = DeprecationLevel.WARNING, replaceWith =
+        ReplaceWith("fullBytes.toHexString(if (isUppercase) HexFormat.UpperCase else HexFormat.Default)")
+    )
     @OptIn(ExperimentalStdlibApi::class)
     override fun toHex(isUppercase: Boolean): String {
         return fullBytes.toHexString(if(isUppercase) HexFormat.UpperCase else HexFormat.Default)
@@ -146,6 +149,9 @@ class KyberEncryptionKey internal constructor(
      *
      * @return [String]
      */
+    @Deprecated("Conversion to base64 values are up to the user.", level = DeprecationLevel.WARNING,
+        replaceWith = ReplaceWith("Base64.encode(fullBytes)", "kotlin.io.encoding.Base64")
+    )
     @OptIn(ExperimentalEncodingApi::class)
     override fun toBase64(): String {
         return Base64.encode(fullBytes)