Merge pull request #176 from ProjectMapK/fix-cache-size

Consolidate cache size to one property

Author: k163377

src/main/kotlin/io/github/projectmapk/jackson/module/kogera/KotlinModule.kt

@@ -17,13 +17,12 @@ import io.github.projectmapk.jackson.module.kogera.deser.singletonSupport.Kotlin
 import io.github.projectmapk.jackson.module.kogera.deser.valueInstantiator.KotlinInstantiators
 import io.github.projectmapk.jackson.module.kogera.ser.serializers.KotlinKeySerializers
 import io.github.projectmapk.jackson.module.kogera.ser.serializers.KotlinSerializers
+import java.io.Serializable
 import java.util.*
 
 /**
- * @param initialCacheSize
- *   Default: [Builder.DEFAULT_CACHE_SIZE]. See [Builder.withInitialCacheSize] for details.
- * @param maxCacheSize
- *   Default: [Builder.DEFAULT_CACHE_SIZE]. See [Builder.withMaxCacheSize] for details.
+ * @param cacheSize
+ *   Default: [Builder.DEFAULT_CACHE_SIZE]. See [CacheSize] for details.
  * @param nullToEmptyCollection
  *   Default: false. See [KotlinFeature.NullToEmptyCollection] for details.
  * @param nullToEmptyMap
@@ -42,8 +41,7 @@ import java.util.*
 // Do not delete default arguments,
 // as this will cause an error during initialization by Spring's Jackson2ObjectMapperBuilder.
 public class KotlinModule private constructor(
-    public val initialCacheSize: Int = Builder.DEFAULT_CACHE_SIZE,
-    public val maxCacheSize: Int = Builder.DEFAULT_CACHE_SIZE,
+    public val cacheSize: CacheSize = CacheSize(),
     public val nullToEmptyCollection: Boolean = NullToEmptyCollection.enabledByDefault,
     public val nullToEmptyMap: Boolean = NullToEmptyMap.enabledByDefault,
     public val nullIsSameAsDefault: Boolean = NullIsSameAsDefault.enabledByDefault,
@@ -54,8 +52,7 @@ public class KotlinModule private constructor(
     public val useJavaDurationConversion: Boolean = UseJavaDurationConversion.enabledByDefault
 ) : SimpleModule(KotlinModule::class.java.name, kogeraVersion) { // kogeraVersion is generated by building.
     private constructor(builder: Builder) : this(
-        builder.initialCacheSize,
-        builder.maxCacheSize,
+        builder.cacheSize,
         builder.isEnabled(NullToEmptyCollection),
         builder.isEnabled(NullToEmptyMap),
         builder.isEnabled(NullIsSameAsDefault),
@@ -71,16 +68,13 @@ public class KotlinModule private constructor(
     )
     public constructor() : this(Builder())
 
-    private val cache: ReflectionCache
-    private val primaryAnnotationIntrospector: KotlinPrimaryAnnotationIntrospector
-    private val fallbackAnnotationIntrospector: KotlinFallbackAnnotationIntrospector
+    private val cache: ReflectionCache = ReflectionCache(cacheSize.initialCacheSize, cacheSize.maxCacheSize)
+    private val primaryAnnotationIntrospector: KotlinPrimaryAnnotationIntrospector =
+        KotlinPrimaryAnnotationIntrospector(nullToEmptyCollection, nullToEmptyMap, cache)
+    private val fallbackAnnotationIntrospector: KotlinFallbackAnnotationIntrospector =
+        KotlinFallbackAnnotationIntrospector(strictNullChecks, useJavaDurationConversion, cache)
 
     init {
-        checkMaxCacheSize(maxCacheSize)
-        checkCacheSize(initialCacheSize, maxCacheSize)
-
-        cache = ReflectionCache(initialCacheSize, maxCacheSize)
-
         _serializers = KotlinSerializers(cache)
         _deserializers = KotlinDeserializers(cache, useJavaDurationConversion)
 
@@ -96,28 +90,11 @@ public class KotlinModule private constructor(
         }
 
         setMixInAnnotation(ClosedRange::class.java, ClosedRangeMixin::class.java)
-
-        primaryAnnotationIntrospector =
-            KotlinPrimaryAnnotationIntrospector(nullToEmptyCollection, nullToEmptyMap, cache)
-        fallbackAnnotationIntrospector =
-            KotlinFallbackAnnotationIntrospector(strictNullChecks, useJavaDurationConversion, cache)
     }
 
     public companion object {
         @Suppress("ConstPropertyName")
-        private const val serialVersionUID = 2L
-
-        private fun checkMaxCacheSize(maxCacheSize: Int) {
-            if (maxCacheSize < 16) throw IllegalArgumentException("16 or higher must be specified")
-        }
-
-        private fun checkCacheSize(initialCacheSize: Int, maxCacheSize: Int) {
-            if (maxCacheSize < initialCacheSize) {
-                throw IllegalArgumentException(
-                    "maxCacheSize($maxCacheSize) was less than initialCacheSize($initialCacheSize)."
-                )
-            }
-        }
+        private const val serialVersionUID = 3L
     }
 
     override fun setupModule(context: SetupContext) {
@@ -137,40 +114,49 @@ public class KotlinModule private constructor(
         }
     }
 
+    /**
+     * @property maxCacheSize Kogera's internal processing requires a certain cache size.
+     *   The lower limit is set to 16 for extreme use cases,
+     *   but it is recommended to set it to 100 or more unless there is a very clear reason.
+     *
+     * @throws IllegalArgumentException Specified [maxCacheSize] was less than the 16.
+     * @throws IllegalArgumentException A value less than [maxCacheSize] was entered for [initialCacheSize].
+     */
+    public data class CacheSize(
+        val initialCacheSize: Int = Builder.DEFAULT_CACHE_SIZE,
+        val maxCacheSize: Int = Builder.DEFAULT_CACHE_SIZE
+    ) : Serializable {
+        /**
+         * Set the same size for [initialCacheSize] and [maxCacheSize].
+         */
+        public constructor(cacheSize: Int) : this(cacheSize, cacheSize)
+
+        init {
+            if (maxCacheSize < 16) {
+                throw IllegalArgumentException(
+                    "The maxCacheSize must be at least 16. The recommended value is 100 or more."
+                )
+            }
+            if (maxCacheSize < initialCacheSize) {
+                throw IllegalArgumentException(
+                    "maxCacheSize($maxCacheSize) was less than initialCacheSize($initialCacheSize)."
+                )
+            }
+        }
+    }
+
     public class Builder {
         public companion object {
             internal const val DEFAULT_CACHE_SIZE = 512
         }
 
-        public var initialCacheSize: Int = DEFAULT_CACHE_SIZE
-            private set
-        public var maxCacheSize: Int = DEFAULT_CACHE_SIZE
+        public var cacheSize: CacheSize = CacheSize()
             private set
 
         private val bitSet: BitSet = KotlinFeature.defaults
 
-        /**
-         * @throws IllegalArgumentException A value less than [maxCacheSize] was entered for [initialCacheSize].
-         */
-        public fun withInitialCacheSize(initialCacheSize: Int): Builder = apply {
-            checkCacheSize(initialCacheSize, maxCacheSize)
-
-            this.initialCacheSize = initialCacheSize
-        }
-
-        /**
-         * Kogera's internal processing requires a certain cache size.
-         * The lower limit of [maxCacheSize] is set to 16 for extreme use cases,
-         * but it is recommended to set it to 100 or more unless there is a very clear reason.
-         *
-         * @throws IllegalArgumentException Specified size was less than the 16.
-         * @throws IllegalArgumentException A value less than [initialCacheSize] was entered for maxCacheSize.
-         */
-        public fun withMaxCacheSize(maxCacheSize: Int): Builder = apply {
-            checkMaxCacheSize(maxCacheSize)
-            checkCacheSize(initialCacheSize, maxCacheSize)
-
-            this.maxCacheSize = maxCacheSize
+        public fun withCacheSize(cacheSize: CacheSize): Builder = apply {
+            this.cacheSize = cacheSize
         }
 
         public fun enable(feature: KotlinFeature): Builder = apply {

src/test/kotlin/io/github/projectmapk/jackson/module/kogera/KotlinModuleTest.kt

@@ -45,7 +45,7 @@ class KotlinModuleTest {
         fun `Cannot set initialCacheSize to a value larger than maxCacheSize`() {
             assertThrows<IllegalArgumentException> {
                 KotlinModule.Builder().apply {
-                    withInitialCacheSize(maxCacheSize + 1)
+                    withCacheSize(KotlinModule.CacheSize(initialCacheSize = KotlinModule.Builder.DEFAULT_CACHE_SIZE + 1))
                 }
             }
         }
@@ -54,7 +54,7 @@ class KotlinModuleTest {
         fun `Cannot set maxCacheSize to a value smaller than initialCacheSize`() {
             assertThrows<IllegalArgumentException> {
                 KotlinModule.Builder().apply {
-                    withMaxCacheSize(initialCacheSize - 1)
+                    withCacheSize(KotlinModule.CacheSize(maxCacheSize = KotlinModule.Builder.DEFAULT_CACHE_SIZE - 1))
                 }
             }
         }
@@ -63,8 +63,7 @@ class KotlinModuleTest {
         fun `Cannot set maxCacheSize to a value smaller than 15`() {
             assertThrows<IllegalArgumentException> {
                 KotlinModule.Builder().apply {
-                    withInitialCacheSize(0)
-                    withMaxCacheSize(15)
+                    KotlinModule.CacheSize(0, 15)
                 }
             }
         }
@@ -73,8 +72,7 @@ class KotlinModuleTest {
         fun test() {
             assertDoesNotThrow {
                 KotlinModule.Builder().apply {
-                    withInitialCacheSize(0)
-                    withMaxCacheSize(16)
+                    KotlinModule.CacheSize(0, 16)
                 }
             }
         }
@@ -84,8 +82,7 @@ class KotlinModuleTest {
     @ValueSource(booleans = [true, false])
     fun jdkSerializabilityTest(enabled: Boolean) {
         val module = KotlinModule.Builder().apply {
-            withInitialCacheSize(123)
-            withMaxCacheSize(321)
+            withCacheSize(KotlinModule.CacheSize(123, 321))
 
             KotlinFeature.values().forEach {
                 configure(it, enabled)
@@ -98,8 +95,7 @@ class KotlinModuleTest {
             val deserialized = jdkDeserialize<KotlinModule>(serialized)
 
             assertNotNull(deserialized)
-            assertEquals(123, deserialized.initialCacheSize)
-            assertEquals(321, deserialized.maxCacheSize)
+            assertEquals(KotlinModule.CacheSize(123, 321), deserialized.cacheSize)
             assertEquals(module.nullToEmptyCollection, deserialized.nullToEmptyCollection)
             assertEquals(module.nullToEmptyMap, deserialized.nullToEmptyMap)
             assertEquals(module.nullIsSameAsDefault, deserialized.nullIsSameAsDefault)

src/test/kotlin/io/github/projectmapk/jackson/module/kogera/zPorted/DslTest.kt

@@ -7,6 +7,7 @@ import io.github.projectmapk.jackson.module.kogera.KotlinFeature.NullToEmptyColl
 import io.github.projectmapk.jackson.module.kogera.KotlinFeature.NullToEmptyMap
 import io.github.projectmapk.jackson.module.kogera.KotlinFeature.SingletonSupport
 import io.github.projectmapk.jackson.module.kogera.KotlinFeature.StrictNullChecks
+import io.github.projectmapk.jackson.module.kogera.KotlinModule
 import io.github.projectmapk.jackson.module.kogera.jsonMapper
 import io.github.projectmapk.jackson.module.kogera.kotlinModule
 import org.junit.jupiter.api.Assertions.assertEquals
@@ -32,7 +33,7 @@ class DslTest {
     @Test
     fun createModuleWithBuilderOptions() {
         val module = kotlinModule {
-            withInitialCacheSize(123)
+            withCacheSize(KotlinModule.CacheSize(123))
             enable(NullToEmptyCollection)
             enable(NullToEmptyMap)
             enable(NullIsSameAsDefault)
@@ -41,7 +42,7 @@ class DslTest {
         }
 
         assertNotNull(module)
-        assertEquals(module.initialCacheSize, 123)
+        assertEquals(module.cacheSize, KotlinModule.CacheSize(123, 123))
         assertTrue(module.nullToEmptyCollection)
         assertTrue(module.nullToEmptyMap)
         assertTrue(module.nullIsSameAsDefault)

src/test/kotlin/io/github/projectmapk/jackson/module/kogera/zPorted/KotlinModuleTest.kt

@@ -19,7 +19,7 @@ class KotlinModuleTest {
     fun builderDefaultsMatchFeatures() {
         val module = KotlinModule.Builder().build()
 
-        assertEquals(module.initialCacheSize, 512)
+        assertEquals(KotlinModule.CacheSize(512), module.cacheSize)
         assertFalse(module.nullToEmptyCollection)
         assertFalse(module.nullToEmptyMap)
         assertFalse(module.nullIsSameAsDefault)
@@ -31,7 +31,7 @@ class KotlinModuleTest {
     fun builder_Defaults() {
         val module = KotlinModule.Builder().build()
 
-        assertEquals(512, module.maxCacheSize)
+        assertEquals(KotlinModule.CacheSize(512), module.cacheSize)
         assertFalse(module.nullToEmptyCollection)
         assertFalse(module.nullToEmptyMap)
         assertFalse(module.nullIsSameAsDefault)
@@ -42,15 +42,15 @@ class KotlinModuleTest {
     @Test
     fun builder_SetAll() {
         val module = KotlinModule.Builder().apply {
-            withInitialCacheSize(123)
+            withCacheSize(KotlinModule.CacheSize(initialCacheSize = 123))
             enable(NullToEmptyCollection)
             enable(NullToEmptyMap)
             enable(NullIsSameAsDefault)
             enable(SingletonSupport)
             enable(StrictNullChecks)
         }.build()
 
-        assertEquals(123, module.initialCacheSize)
+        assertEquals(123, module.cacheSize.initialCacheSize)
         assertTrue(module.nullToEmptyCollection)
         assertTrue(module.nullToEmptyMap)
         assertTrue(module.nullIsSameAsDefault)