Create Builder for KotlinModule

release-notes/VERSION-2.x

@@ -7,6 +7,7 @@ Project: jackson-module-kotlin
 2.11.0 (not yet released)
 
 #284: Use `AnnotationIntrospector.findRenameByField()` to support "is properties"
+- Add Builder for KotlinModule
 
 Kotlin updated to 1.3.61
 

src/main/kotlin/com/fasterxml/jackson/module/kotlin/KotlinModule.kt

@@ -14,16 +14,22 @@ class KotlinModule constructor (
     val reflectionCacheSize: Int = 512,
     val nullToEmptyCollection: Boolean = false,
     val nullToEmptyMap: Boolean = false,
-    val nullisSameAsDefault: Boolean = false
+    val nullIsSameAsDefault: Boolean = false
 ) : SimpleModule(PackageVersion.VERSION) {
-
     @Deprecated(level = DeprecationLevel.HIDDEN, message = "For ABI compatibility")
     constructor(
         reflectionCacheSize: Int = 512,
         nullToEmptyCollection: Boolean = false,
         nullToEmptyMap: Boolean = false
     ) : this(reflectionCacheSize, nullToEmptyCollection, nullToEmptyMap, false)
 
+    private constructor(builder: Builder) : this(
+        builder.reflectionCacheSize,
+        builder.nullToEmptyCollection,
+        builder.nullToEmptyMap,
+        builder.nullIsSameAsDefault
+    )
+
     companion object {
         const val serialVersionUID = 1L
     }
@@ -39,12 +45,12 @@ class KotlinModule constructor (
 
         val cache = ReflectionCache(reflectionCacheSize)
 
-        context.addValueInstantiators(KotlinInstantiators(cache, nullToEmptyCollection, nullToEmptyMap, nullisSameAsDefault))
+        context.addValueInstantiators(KotlinInstantiators(cache, nullToEmptyCollection, nullToEmptyMap, nullIsSameAsDefault))
 
         // [module-kotlin#225]: keep Kotlin singletons as singletons
         context.addBeanDeserializerModifier(KotlinBeanDeserializerModifier)
 
-        context.insertAnnotationIntrospector(KotlinAnnotationIntrospector(context, cache, nullToEmptyCollection, nullToEmptyMap, nullisSameAsDefault))
+        context.insertAnnotationIntrospector(KotlinAnnotationIntrospector(context, cache, nullToEmptyCollection, nullToEmptyMap, nullIsSameAsDefault))
         context.appendAnnotationIntrospector(KotlinNamesAnnotationIntrospector(this, cache, ignoredClassesForImplyingJsonCreator))
 
         context.addDeserializers(KotlinDeserializers())
@@ -60,6 +66,30 @@ class KotlinModule constructor (
         addMixIn(LongRange::class.java, ClosedRangeMixin::class.java)
         addMixIn(ClosedRange::class.java, ClosedRangeMixin::class.java)
     }
+
+    class Builder {
+        var reflectionCacheSize: Int = 512
+            private set
+
+        var nullToEmptyCollection: Boolean = false
+            private set
+
+        var nullToEmptyMap: Boolean = false
+            private set
+
+        var nullIsSameAsDefault: Boolean = false
+            private set
+
+        fun reflectionCacheSize(reflectionCacheSize: Int) = apply { this.reflectionCacheSize = reflectionCacheSize }
+
+        fun nullToEmptyCollection(nullToEmptyCollection: Boolean) = apply { this.nullToEmptyCollection = nullToEmptyCollection }
+
+        fun nullToEmptyMap(nullToEmptyMap: Boolean) = apply { this.nullToEmptyMap = nullToEmptyMap }
+
+        fun nullIsSameAsDefault(nullIsSameAsDefault: Boolean) = apply { this.nullIsSameAsDefault = nullIsSameAsDefault }
+
+        fun build() = KotlinModule(this)
+    }
 }
 
 

src/test/kotlin/com/fasterxml/jackson/module/kotlin/KotlinModuleTest.kt

@@ -0,0 +1,67 @@
+package com.fasterxml.jackson.module.kotlin
+
+import org.junit.Assert.*
+import org.junit.Test
+
+class KotlinModuleTest {
+    @Test
+    fun builder_Defaults() {
+        val module = KotlinModule.Builder().build()
+
+        assertEquals(512, module.reflectionCacheSize)
+        assertFalse(module.nullToEmptyCollection)
+        assertFalse(module.nullToEmptyMap)
+        assertFalse(module.nullIsSameAsDefault)
+    }
+
+    @Test
+    fun builder_SetAll() {
+        val module = KotlinModule.Builder().apply {
+            reflectionCacheSize(123)
+            nullToEmptyCollection(true)
+            nullToEmptyMap(true)
+            nullIsSameAsDefault(true)
+        }.build()
+
+        assertEquals(123, module.reflectionCacheSize)
+        assertTrue(module.nullToEmptyCollection)
+        assertTrue(module.nullToEmptyMap)
+        assertTrue(module.nullIsSameAsDefault)
+    }
+
+    @Test
+    fun builder_NullToEmptyCollection() {
+        val module = KotlinModule.Builder().apply {
+            nullToEmptyCollection(true)
+        }.build()
+
+        assertEquals(512, module.reflectionCacheSize)
+        assertTrue(module.nullToEmptyCollection)
+        assertFalse(module.nullToEmptyMap)
+        assertFalse(module.nullIsSameAsDefault)
+    }
+
+    @Test
+    fun builder_NullToEmptyMap() {
+        val module = KotlinModule.Builder().apply {
+            nullToEmptyMap(true)
+        }.build()
+
+        assertEquals(512, module.reflectionCacheSize)
+        assertFalse(module.nullToEmptyCollection)
+        assertTrue(module.nullToEmptyMap)
+        assertFalse(module.nullIsSameAsDefault)
+    }
+
+    @Test
+    fun builder_NullIsSameAsDefault() {
+        val module = KotlinModule.Builder().apply {
+            nullIsSameAsDefault(true)
+        }.build()
+
+        assertEquals(512, module.reflectionCacheSize)
+        assertFalse(module.nullToEmptyCollection)
+        assertFalse(module.nullToEmptyMap)
+        assertTrue(module.nullIsSameAsDefault)
+    }
+}

src/test/kotlin/com/fasterxml/jackson/module/kotlin/test/NullToDefaultTests.kt

@@ -3,16 +3,13 @@ package com.fasterxml.jackson.module.kotlin.test
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.module.kotlin.KotlinModule
 import com.fasterxml.jackson.module.kotlin.MissingKotlinParameterException
-import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import com.fasterxml.jackson.module.kotlin.readValue
 import org.junit.Assert
-import org.junit.Ignore
 import org.junit.Test
-import org.junit.internal.runners.statements.ExpectException
 
 class TestNullToDefault {
 
-	private fun createMapper(allowDefaultingByNull: Boolean) = ObjectMapper().registerModule(KotlinModule(nullisSameAsDefault = allowDefaultingByNull))
+	private fun createMapper(allowDefaultingByNull: Boolean) = ObjectMapper().registerModule(KotlinModule(nullIsSameAsDefault = allowDefaultingByNull))
 
 	private data class TestClass(val sku: Int = -1,
 								 val text: String,
@@ -81,4 +78,4 @@ class TestNullToDefault {
 		Assert.assertTrue(item.name != null)
 		Assert.assertTrue(item.order == -1)
 	}
-}
+}

src/test/kotlin/com/fasterxml/jackson/module/kotlin/test/ParameterNameTests.kt

@@ -36,8 +36,8 @@ class TestJacksonWithKotlin {
         }
     }
 
-    private val normalCasedJson = """{"name":"Frank","age":30,"primaryAddress":"something here","renamed":true,"createdDt":"2016-10-25T18:25:48.000+0000"}"""
-    private val pascalCasedJson = """{"Name":"Frank","Age":30,"PrimaryAddress":"something here","Renamed":true,"CreatedDt":"2016-10-25T18:25:48.000+0000"}"""
+    private val normalCasedJson = """{"name":"Frank","age":30,"primaryAddress":"something here","renamed":true,"createdDt":"2016-10-25T18:25:48.000+00:00"}"""
+    private val pascalCasedJson = """{"Name":"Frank","Age":30,"PrimaryAddress":"something here","Renamed":true,"CreatedDt":"2016-10-25T18:25:48.000+00:00"}"""
 
     private val normalCasedMapper = jacksonObjectMapper()
             .configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false)