fixup! Rename to forbidDuplicateKeys; rename exception; related cleanup

Author: timmc

core/api/kotlinx-serialization-core.api

@@ -19,7 +19,7 @@ public abstract interface class kotlinx/serialization/DeserializationStrategy {
 	public abstract fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor;
 }
 
-public final class kotlinx/serialization/DuplicateMapKeyException : kotlinx/serialization/SerializationException {
+public final class kotlinx/serialization/DuplicateKeyException : kotlinx/serialization/SerializationException {
 	public fun <init> (Ljava/lang/Object;)V
 }
 

core/api/kotlinx-serialization-core.klib.api

@@ -523,8 +523,8 @@ final class kotlinx.serialization.modules/SerializersModuleBuilder : kotlinx.ser
     final fun build(): kotlinx.serialization.modules/SerializersModule // kotlinx.serialization.modules/SerializersModuleBuilder.build|build(){}[0]
     final fun include(kotlinx.serialization.modules/SerializersModule) // kotlinx.serialization.modules/SerializersModuleBuilder.include|include(kotlinx.serialization.modules.SerializersModule){}[0]
 }
-final class kotlinx.serialization/DuplicateMapKeyException : kotlinx.serialization/SerializationException { // kotlinx.serialization/DuplicateMapKeyException|null[0]
-    constructor <init>(kotlin/Any?) // kotlinx.serialization/DuplicateMapKeyException.<init>|<init>(kotlin.Any?){}[0]
+final class kotlinx.serialization/DuplicateKeyException : kotlinx.serialization/SerializationException { // kotlinx.serialization/DuplicateKeyException|null[0]
+    constructor <init>(kotlin/Any?) // kotlinx.serialization/DuplicateKeyException.<init>|<init>(kotlin.Any?){}[0]
 }
 final class kotlinx.serialization/MissingFieldException : kotlinx.serialization/SerializationException { // kotlinx.serialization/MissingFieldException|null[0]
     constructor <init>(kotlin.collections/List<kotlin/String>, kotlin/String) // kotlinx.serialization/MissingFieldException.<init>|<init>(kotlin.collections.List<kotlin.String>;kotlin.String){}[0]

core/commonMain/src/kotlinx/serialization/SerializationExceptions.kt

@@ -135,8 +135,8 @@ internal constructor(message: String?) : SerializationException(message) {
 }
 
 /**
- * Thrown when a map deserializer encounters a repeated map key (and configuration disallows this.)
+ * Thrown when a deserializer encounters a repeated key (and configuration disallows this.)
  */
 @ExperimentalSerializationApi
-public class DuplicateMapKeyException(key: Any?) :
-    SerializationException("Duplicate keys not allowed in maps. Key appeared twice: $key")
+public class DuplicateKeyException(key: Any?) :
+    SerializationException("Duplicate keys not allowed. Key appeared twice: $key")

formats/cbor/api/kotlinx-serialization-cbor.api

@@ -17,12 +17,12 @@ public final class kotlinx/serialization/cbor/Cbor$Default : kotlinx/serializati
 }
 
 public final class kotlinx/serialization/cbor/CborBuilder {
-	public final fun getAllowDuplicateKeys ()Z
 	public final fun getEncodeDefaults ()Z
+	public final fun getForbidDuplicateKeys ()Z
 	public final fun getIgnoreUnknownKeys ()Z
 	public final fun getSerializersModule ()Lkotlinx/serialization/modules/SerializersModule;
-	public final fun setAllowDuplicateKeys (Z)V
 	public final fun setEncodeDefaults (Z)V
+	public final fun setForbidDuplicateKeys (Z)V
 	public final fun setIgnoreUnknownKeys (Z)V
 	public final fun setSerializersModule (Lkotlinx/serialization/modules/SerializersModule;)V
 }

formats/cbor/api/kotlinx-serialization-cbor.klib.api

@@ -7,12 +7,12 @@
 
 // Library unique name: <org.jetbrains.kotlinx:kotlinx-serialization-cbor>
 final class kotlinx.serialization.cbor/CborBuilder { // kotlinx.serialization.cbor/CborBuilder|null[0]
-    final var allowDuplicateKeys // kotlinx.serialization.cbor/CborBuilder.allowDuplicateKeys|<get-allowDuplicateKeys>(){}[0]
-        final fun <get-allowDuplicateKeys>(): kotlin/Boolean // kotlinx.serialization.cbor/CborBuilder.allowDuplicateKeys.<get-allowDuplicateKeys>|<get-allowDuplicateKeys>(){}[0]
-        final fun <set-allowDuplicateKeys>(kotlin/Boolean) // kotlinx.serialization.cbor/CborBuilder.allowDuplicateKeys.<set-allowDuplicateKeys>|<set-allowDuplicateKeys>(kotlin.Boolean){}[0]
     final var encodeDefaults // kotlinx.serialization.cbor/CborBuilder.encodeDefaults|<get-encodeDefaults>(){}[0]
         final fun <get-encodeDefaults>(): kotlin/Boolean // kotlinx.serialization.cbor/CborBuilder.encodeDefaults.<get-encodeDefaults>|<get-encodeDefaults>(){}[0]
         final fun <set-encodeDefaults>(kotlin/Boolean) // kotlinx.serialization.cbor/CborBuilder.encodeDefaults.<set-encodeDefaults>|<set-encodeDefaults>(kotlin.Boolean){}[0]
+    final var forbidDuplicateKeys // kotlinx.serialization.cbor/CborBuilder.forbidDuplicateKeys|<get-forbidDuplicateKeys>(){}[0]
+        final fun <get-forbidDuplicateKeys>(): kotlin/Boolean // kotlinx.serialization.cbor/CborBuilder.forbidDuplicateKeys.<get-forbidDuplicateKeys>|<get-forbidDuplicateKeys>(){}[0]
+        final fun <set-forbidDuplicateKeys>(kotlin/Boolean) // kotlinx.serialization.cbor/CborBuilder.forbidDuplicateKeys.<set-forbidDuplicateKeys>|<set-forbidDuplicateKeys>(kotlin.Boolean){}[0]
     final var ignoreUnknownKeys // kotlinx.serialization.cbor/CborBuilder.ignoreUnknownKeys|<get-ignoreUnknownKeys>(){}[0]
         final fun <get-ignoreUnknownKeys>(): kotlin/Boolean // kotlinx.serialization.cbor/CborBuilder.ignoreUnknownKeys.<get-ignoreUnknownKeys>|<get-ignoreUnknownKeys>(){}[0]
         final fun <set-ignoreUnknownKeys>(kotlin/Boolean) // kotlinx.serialization.cbor/CborBuilder.ignoreUnknownKeys.<set-ignoreUnknownKeys>|<set-ignoreUnknownKeys>(kotlin.Boolean){}[0]

formats/cbor/commonMain/src/kotlinx/serialization/cbor/Cbor.kt

@@ -32,14 +32,14 @@ import kotlinx.serialization.modules.*
 public sealed class Cbor(
     internal val encodeDefaults: Boolean,
     internal val ignoreUnknownKeys: Boolean,
-    internal val allowDuplicateKeys: Boolean,
+    internal val forbidDuplicateKeys: Boolean,
     override val serializersModule: SerializersModule
 ) : BinaryFormat {
 
     /**
      * The default instance of [Cbor]
      */
-    public companion object Default : Cbor(false, false, true, EmptySerializersModule())
+    public companion object Default : Cbor(false, false, false, EmptySerializersModule())
 
     override fun <T> encodeToByteArray(serializer: SerializationStrategy<T>, value: T): ByteArray {
         val output = ByteArrayOutput()
@@ -57,10 +57,10 @@ public sealed class Cbor(
 
 @OptIn(ExperimentalSerializationApi::class)
 private class CborImpl(
-    encodeDefaults: Boolean, ignoreUnknownKeys: Boolean, allowDuplicateKeys: Boolean,
+    encodeDefaults: Boolean, ignoreUnknownKeys: Boolean, forbidDuplicateKeys: Boolean,
     serializersModule: SerializersModule,
 ) :
-    Cbor(encodeDefaults, ignoreUnknownKeys, allowDuplicateKeys, serializersModule)
+    Cbor(encodeDefaults, ignoreUnknownKeys, forbidDuplicateKeys, serializersModule)
 
 /**
  * Creates an instance of [Cbor] configured from the optionally given [Cbor instance][from]
@@ -70,7 +70,7 @@ private class CborImpl(
 public fun Cbor(from: Cbor = Cbor, builderAction: CborBuilder.() -> Unit): Cbor {
     val builder = CborBuilder(from)
     builder.builderAction()
-    return CborImpl(builder.encodeDefaults, builder.ignoreUnknownKeys, builder.allowDuplicateKeys, builder.serializersModule)
+    return CborImpl(builder.encodeDefaults, builder.ignoreUnknownKeys, builder.forbidDuplicateKeys, builder.serializersModule)
 }
 
 /**
@@ -94,10 +94,10 @@ public class CborBuilder internal constructor(cbor: Cbor) {
     /**
      * Specifies whether it is an error to read a map with duplicate keys.
      *
-     * If this is set to false, decoding a map with two keys that compare as equal
-     * will cause a [DuplicateMapKeyException] error to be thrown.
+     * If this is set to true, decoding a map with two keys that compare as equal
+     * will cause a [DuplicateKeyException] error to be thrown.
      */
-    public var allowDuplicateKeys: Boolean = cbor.allowDuplicateKeys
+    public var forbidDuplicateKeys: Boolean = cbor.forbidDuplicateKeys
 
     /**
      * Module with contextual and polymorphic serializers to be used in the resulting [Cbor] instance.

formats/cbor/commonMain/src/kotlinx/serialization/cbor/internal/Encoding.kt

@@ -198,18 +198,18 @@ internal class CborEncoder(private val output: ByteArrayOutput) {
 }
 
 private class CborMapReader(val cbor: Cbor, decoder: CborDecoder) : CborListReader(cbor, decoder) {
-    /** Keys that have been seen so far while reading this map. */
+    /**
+     * Keys that have been seen so far while reading this map.
+     *
+     * Only used if [Cbor.forbidDuplicateKeys] is in effect.
+     */
     private val seenKeys = mutableSetOf<Any?>()
 
     override fun skipBeginToken() = setSize(decoder.startMap() * 2)
 
     override fun visitKey(key: Any?) {
-        if (cbor.allowDuplicateKeys)
-            return
-
-        val added = seenKeys.add(key)
-        if (!added) {
-            throw DuplicateMapKeyException(key)
+        if (cbor.forbidDuplicateKeys) {
+            seenKeys.add(key) || throw DuplicateKeyException(key)
         }
     }
 }

formats/cbor/commonTest/src/kotlinx/serialization/cbor/CborStrictModeTest.kt

@@ -3,17 +3,17 @@ package kotlinx.serialization.cbor
 import kotlinx.serialization.assertFailsWithMessage
 import kotlinx.serialization.decodeFromByteArray
 import kotlinx.serialization.HexConverter
-import kotlinx.serialization.DuplicateMapKeyException
+import kotlinx.serialization.DuplicateKeyException
 import kotlin.test.Test
 
 class CborStrictModeTest {
-    private val strict = Cbor { allowDuplicateKeys = false }
+    private val strict = Cbor { forbidDuplicateKeys = true }
 
     /** Duplicate keys are rejected in generic maps. */
     @Test
     fun testDuplicateKeysInMap() {
         val duplicateKeys = HexConverter.parseHexBinary("A2617805617806")
-        assertFailsWithMessage<DuplicateMapKeyException>("Duplicate keys not allowed in maps. Key appeared twice: x") {
+        assertFailsWithMessage<DuplicateKeyException>("Duplicate keys not allowed. Key appeared twice: x") {
             strict.decodeFromByteArray<Map<String, Long>>(duplicateKeys)
         }
     }