From 333b296f0da76a3b7cc5e048390cb51bdd9d95bf Mon Sep 17 00:00:00 2001 From: Mincong HUANG Date: Sun, 29 Mar 2020 12:11:20 +0200 Subject: [PATCH] Doc: update serialization/deserialization in README --- README.md | 15 ++++++----- .../jackson/datatype/docs/ReadmeTest.java | 26 +++++++++++++++++++ 2 files changed, 35 insertions(+), 6 deletions(-) create mode 100644 src/test/java/io/vavr/jackson/datatype/docs/ReadmeTest.java diff --git a/README.md b/README.md index 80a08b2..32eee72 100644 --- a/README.md +++ b/README.md @@ -31,15 +31,18 @@ Just register a new instance of VavrModule ObjectMapper mapper = new ObjectMapper(); mapper.registerModule(new VavrModule()); ``` + ### Serialization/deserialization + + + ```java -String json = mapper.writer().writeValueAsString(List.of(List.of(1))); -// = [[1]] -Object restored1 = mapper.readValue(json, List.class); -// = List(java.util.ArrayList(1)) -Object restored2 = mapper.readValue(json, new TypeReference>>() {}); -// = List(List(1)) +String json = mapper.writeValueAsString(List.of(1)); +// = [1] +List restored = mapper.readValue(json, new TypeReference>() {}); +// = List(1) ``` + ## Using Developer Versions Developer versions can be found [here](https://oss.sonatype.org/content/repositories/snapshots/io/vavr/vavr-jackson). diff --git a/src/test/java/io/vavr/jackson/datatype/docs/ReadmeTest.java b/src/test/java/io/vavr/jackson/datatype/docs/ReadmeTest.java new file mode 100644 index 0000000..69590c3 --- /dev/null +++ b/src/test/java/io/vavr/jackson/datatype/docs/ReadmeTest.java @@ -0,0 +1,26 @@ +package io.vavr.jackson.datatype.docs; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.ObjectMapper; +import io.vavr.collection.List; +import io.vavr.jackson.datatype.BaseTest; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +class ReadmeTest extends BaseTest { + + @Test + void testDeser() throws Exception { + ObjectMapper mapper = mapper(); + + // readme: Serialization/deserialization + String json = mapper.writeValueAsString(List.of(1)); + List restored = mapper.readValue(json, new TypeReference>() {}); + // end of readme + + assertEquals("[1]", json); + assertEquals(List.of(1), restored); + assertEquals("List(1)", restored.toString()); + } +}