diff --git a/README.md b/README.md index 0c1da56f..a8421a08 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ and those with secondary constructors or static factories are also supported. # Status -* release `2.15.1` (for Jackson `2.15.x`) [![GitHub Actions build](https://github.com/FasterXML/jackson-module-kotlin/actions/workflows/main.yml/badge.svg?branch=2.14)](https://github.com/FasterXML/jackson-module-kotlin/actions?query=branch%3A2.14) +* release `2.15.2` (for Jackson `2.15.x`) [![GitHub Actions build](https://github.com/FasterXML/jackson-module-kotlin/actions/workflows/main.yml/badge.svg?branch=2.15)](https://github.com/FasterXML/jackson-module-kotlin/actions?query=branch%3A2.15) * release `2.14.3` (for Jackson `2.14.x`) [![GitHub Actions build](https://github.com/FasterXML/jackson-module-kotlin/actions/workflows/main.yml/badge.svg?branch=2.14)](https://github.com/FasterXML/jackson-module-kotlin/actions?query=branch%3A2.14) * release `2.13.5` (for Jackson `2.13.x`) [![GitHub Actions build](https://github.com/FasterXML/jackson-module-kotlin/actions/workflows/main.yml/badge.svg?branch=2.13)](https://github.com/FasterXML/jackson-module-kotlin/actions?query=branch%3A2.13) @@ -154,6 +154,7 @@ Note that using `lateinit` or `Delegates.notNull()` will ensure that the value i # Caveats * The `@JsonCreator` annotation is optional unless you have more than one constructor that is valid, or you want to use a static factory method (which also must have `platformStatic` annotation, e.g. `@JvmStatic`). In these cases, annotate only one method as `JsonCreator`. +* During deserialization, if the definition on `Kotlin` is a non-null primitive and `null` is entered explicitly on `JSON`, processing will continue with an unintended default value. [This problem is fixed by enabling `DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES` on `ObjectMapper`](https://github.com/FasterXML/jackson-module-kotlin/issues/242#issuecomment-792570655). * Serializing a member or top-level Kotlin class that implements Iterator requires a workaround, see [Issue #4](https://github.com/FasterXML/jackson-module-kotlin/issues/4) for easy workarounds. * If using proguard: * `kotlin.Metadata` annotations may be stripped, preventing deserialization. Add a proguard rule to keep the `kotlin.Metadata` class: `-keep class kotlin.Metadata { *; }` @@ -215,7 +216,7 @@ provided for configuring these options: ```java KotlinModule kotlinModule = new KotlinModule.Builder() - .strictNullChecks(true) + .enable(KotlinFeature.StrictNullChecks) .build(); ObjectMapper objectMapper = JsonMapper.builder() .addModule(kotlinModule) @@ -261,8 +262,8 @@ See the [main Jackson contribution guidlines](https://github.com/FasterXML/jacks If you are going to write code, choose the appropriate base branch: -- `2.14` for bugfixes against the current stable version -- `2.15` for additive functionality & features or [minor](https://semver.org), backwards compatible changes to existing behavior to be included in the next minor version release +- `2.15` for bugfixes against the current stable version +- `2.16` for additive functionality & features or [minor](https://semver.org), backwards compatible changes to existing behavior to be included in the next minor version release - `master` for significant changes to existing behavior, which will be part of Jackson 3.0 ### Failing tests