Skip to content

Commit 0c52167

Browse files
k163377k163377
authored
Merge pull request #835 from k163377/fix-dep
Remove old SingletonSupport class and unified with KotlinFeature.SingletonSupport
2 parents 25a3cee + 68b605d commit 0c52167

File tree

6 files changed

+33
-76
lines changed

6 files changed

+33
-76
lines changed

‎pom.xml‎

Lines changed: 3 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@
224224
-->
225225
<!-- 30-Sep-2023, wrongwrong: For 2.16, compare to 2.15.2 baseline
226226
-->
227-
<version>2.17.0</version>
227+
<version>2.18.0</version>
228228
<type>jar</type>
229229
</dependency>
230230
</oldVersion>
@@ -239,43 +239,9 @@
239239
<excludes>
240240
<!-- public -->
241241
<!-- removed -->
242-
<exclude>
243-
com.fasterxml.jackson.module.kotlin.KotlinModule#KotlinModule(int,boolean,boolean,boolean,com.fasterxml.jackson.module.kotlin.SingletonSupport,boolean,boolean,boolean)
244-
</exclude>
245-
<exclude>com.fasterxml.jackson.module.kotlin.KotlinModule$Builder#getNullIsSameAsDefault()
246-
</exclude>
247-
<exclude>
248-
com.fasterxml.jackson.module.kotlin.KotlinModule$Builder#nullIsSameAsDefault(boolean)
249-
</exclude>
250-
<exclude>
251-
com.fasterxml.jackson.module.kotlin.KotlinModule$Builder#getNullToEmptyCollection()
252-
</exclude>
253-
<exclude>
254-
com.fasterxml.jackson.module.kotlin.KotlinModule$Builder#nullToEmptyCollection(boolean)
255-
</exclude>
256-
<exclude>com.fasterxml.jackson.module.kotlin.KotlinModule$Builder#getNullToEmptyMap()
257-
</exclude>
258-
<exclude>com.fasterxml.jackson.module.kotlin.KotlinModule$Builder#nullToEmptyMap(boolean)
259-
</exclude>
260-
<exclude>com.fasterxml.jackson.module.kotlin.KotlinModule$Builder#getSingletonSupport()
261-
</exclude>
262-
<exclude>
263-
com.fasterxml.jackson.module.kotlin.KotlinModule$Builder#singletonSupport(com.fasterxml.jackson.module.kotlin.SingletonSupport)
264-
</exclude>
265-
<exclude>com.fasterxml.jackson.module.kotlin.KotlinModule$Builder#getStrictNullChecks()
266-
</exclude>
267-
<exclude>
268-
com.fasterxml.jackson.module.kotlin.KotlinModule$Builder#strictNullChecks(boolean)
269-
</exclude>
270-
<exclude>com.fasterxml.jackson.module.kotlin.KotlinModule$Builder#reflectionCacheSize(int)
271-
</exclude>
242+
<exclude>com.fasterxml.jackson.module.kotlin.KotlinModule#getSingletonSupport()</exclude>
243+
<exclude>com.fasterxml.jackson.module.kotlin.SingletonSupport</exclude>
272244
<!-- internal -->
273-
<exclude>
274-
com.fasterxml.jackson.module.kotlin.KotlinNamesAnnotationIntrospector#KotlinNamesAnnotationIntrospector(com.fasterxml.jackson.module.kotlin.ReflectionCache,java.util.Set,boolean)
275-
</exclude>
276-
<exclude>
277-
com.fasterxml.jackson.module.kotlin.ReflectionCache#checkConstructorIsCreatorAnnotated(com.fasterxml.jackson.databind.introspect.AnnotatedConstructor,kotlin.jvm.functions.Function1)
278-
</exclude>
279245

280246
</excludes>
281247
</parameter>

‎release-notes/CREDITS-2.x‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ Authors:
1515

1616
Contributors:
1717

18+
# 2.19.0 (not yet released)
19+
20+
WrongWrong (@k163377)
21+
* #835: Remove old SingletonSupport class and unified with KotlinFeature.SingletonSupport
22+
1823
# 2.18.0 (26-Sep-2024)
1924

2025
WrongWrong (@k163377)

‎release-notes/VERSION-2.x‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Co-maintainers:
1818

1919
2.19.0 (not yet released)
2020

21-
- No changes since 2.18
21+
#835: Remove old SingletonSupport class and unified with KotlinFeature.SingletonSupport.
2222

2323
2.18.0 (26-Sep-2024)
2424

‎src/main/kotlin/com/fasterxml/jackson/module/kotlin/KotlinFeature.kt‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ enum class KotlinFeature(internal val enabledByDefault: Boolean) {
3030
* Deserializing a singleton overwrites the value of the single instance.
3131
*
3232
* See [jackson-module-kotlin#225]: keep Kotlin singletons as singletons.
33-
* @see com.fasterxml.jackson.module.kotlin.SingletonSupport
3433
*/
3534
SingletonSupport(enabledByDefault = false),
3635

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

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ import com.fasterxml.jackson.databind.module.SimpleModule
55
import com.fasterxml.jackson.module.kotlin.KotlinFeature.NullIsSameAsDefault
66
import com.fasterxml.jackson.module.kotlin.KotlinFeature.NullToEmptyCollection
77
import com.fasterxml.jackson.module.kotlin.KotlinFeature.NullToEmptyMap
8+
import com.fasterxml.jackson.module.kotlin.KotlinFeature.SingletonSupport
89
import com.fasterxml.jackson.module.kotlin.KotlinFeature.StrictNullChecks
910
import com.fasterxml.jackson.module.kotlin.KotlinFeature.KotlinPropertyNameAsImplicitName
1011
import com.fasterxml.jackson.module.kotlin.KotlinFeature.UseJavaDurationConversion
1112
import java.util.*
12-
import kotlin.reflect.KClass
1313

1414
fun Class<*>.isKotlinClass(): Boolean = this.isAnnotationPresent(Metadata::class.java)
1515

@@ -23,8 +23,8 @@ fun Class<*>.isKotlinClass(): Boolean = this.isAnnotationPresent(Metadata::class
2323
* map object.
2424
* @property nullIsSameAsDefault Default false. Whether to treat null values as absent when deserializing, thereby
2525
* using the default value provided in Kotlin.
26-
* @property singletonSupport Default: DISABLED. Mode for singleton handling.
27-
* See {@link com.fasterxml.jackson.module.kotlin.SingletonSupport label}
26+
* @property singletonSupport Default: false. Mode for singleton handling.
27+
* See [KotlinFeature.SingletonSupport]
2828
* @property enabledSingletonSupport Default: false. A temporary property that is maintained until the return value of `singletonSupport` is changed.
2929
* It will be removed in 2.21.
3030
* @property strictNullChecks Default: false. Whether to check deserialized collections. With this disabled,
@@ -41,13 +41,7 @@ class KotlinModule private constructor(
4141
val nullToEmptyCollection: Boolean = NullToEmptyCollection.enabledByDefault,
4242
val nullToEmptyMap: Boolean = NullToEmptyMap.enabledByDefault,
4343
val nullIsSameAsDefault: Boolean = NullIsSameAsDefault.enabledByDefault,
44-
@property:Deprecated(
45-
level = DeprecationLevel.ERROR,
46-
message = "The return value will be Boolean in 2.19. Until then, use enabledSingletonSupport.",
47-
replaceWith = ReplaceWith("enabledSingletonSupport")
48-
)
49-
@Suppress("DEPRECATION_ERROR")
50-
val singletonSupport: SingletonSupport = SingletonSupport.DISABLED,
44+
val singletonSupport: Boolean = SingletonSupport.enabledByDefault,
5145
val strictNullChecks: Boolean = StrictNullChecks.enabledByDefault,
5246
@Deprecated(
5347
level = DeprecationLevel.ERROR,
@@ -60,12 +54,28 @@ class KotlinModule private constructor(
6054
) : SimpleModule(KotlinModule::class.java.name, PackageVersion.VERSION) {
6155
@Suppress("DEPRECATION_ERROR")
6256
val kotlinPropertyNameAsImplicitName: Boolean get() = useKotlinPropertyNameForGetter
63-
@Suppress("DEPRECATION_ERROR")
64-
val enabledSingletonSupport: Boolean get() = singletonSupport == SingletonSupport.CANONICALIZE
57+
58+
/*
59+
* Prior to 2.18, an older Enum called SingletonSupport was used to manage feature.
60+
* To deprecate it and replace it with singletonSupport: Boolean, the following steps are in progress.
61+
*
62+
* 1. add enabledSingletonSupport: Boolean property
63+
* 2. delete SingletonSupport class and change the property to singletonSupport: Boolean
64+
* 3. remove the enabledSingletonSupport property
65+
*
66+
* Now that 2 is complete, deprecation is in progress for 3.
67+
*/
68+
@Deprecated(
69+
level = DeprecationLevel.WARNING,
70+
message = "This property is scheduled to be removed in 2.21 or later" +
71+
" in order to unify the use of KotlinFeature.",
72+
replaceWith = ReplaceWith("singletonSupport")
73+
)
74+
val enabledSingletonSupport: Boolean get() = singletonSupport
6575

6676
companion object {
6777
// Increment when option is added
68-
private const val serialVersionUID = 2L
78+
private const val serialVersionUID = 3L
6979
}
7080

7181
@Deprecated(
@@ -79,11 +89,7 @@ class KotlinModule private constructor(
7989
builder.isEnabled(NullToEmptyCollection),
8090
builder.isEnabled(NullToEmptyMap),
8191
builder.isEnabled(NullIsSameAsDefault),
82-
@Suppress("DEPRECATION_ERROR")
83-
when {
84-
builder.isEnabled(KotlinFeature.SingletonSupport) -> SingletonSupport.CANONICALIZE
85-
else -> SingletonSupport.DISABLED
86-
},
92+
builder.isEnabled(SingletonSupport),
8793
builder.isEnabled(StrictNullChecks),
8894
builder.isEnabled(KotlinPropertyNameAsImplicitName),
8995
builder.isEnabled(UseJavaDurationConversion),

‎src/main/kotlin/com/fasterxml/jackson/module/kotlin/SingletonSupport.kt‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)