Merge pull request realtimetech-solution#30 from devjeonghwan/add-wit…

…h-type Add `WithType` description to README.md
devjeonghwan · Aug 21, 2023 · 05a234d · 05a234d
2 parents b70e7a1 + 8f67c1d
commit 05a234d
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 5 deletions.
diff --git a/.idea/modules/opack.main.iml b/.idea/modules/opack.main.iml
diff --git a/.idea/modules/opack.test.iml b/.idea/modules/opack.test.iml
diff --git a/.idea/opack.iml b/.idea/opack.iml
diff --git a/README.md b/README.md
@@ -202,7 +202,19 @@ public class SomeObject {
     private byte[] bytesField;
 }
 ```
-#### 3. Class Transformer
+#### 3. Field With Type
+```java
+public class SomeObject {
+    // This field will serialize with runtime type, and deserialize actual type instead of ambiguous field type `List`
+    @WithType
+    private List<String> stringListField;
+
+    // This field will serialize with runtime type, and deserialize actual type instead of ambiguous field type `Object`
+    @WithType
+    private Object[] objectArrayField;
+}
+```
+#### 4. Class Transformer
 ```java
 public class AnimalTransformer implements Transformer {
     /*
@@ -271,7 +283,7 @@ public class SomeObject {
 }
 ```
 
-#### 4. Handling Opack Value
+#### 5. Handling Opack Value
 ```java
 OpackObject<String, OpackValue> rootObject = new OpackObject<>();
 
@@ -316,6 +328,7 @@ System.out.println("First element is " + (opackArray.get(0)));
 - [ ] Add generic into transformer for type safety
 - [ ] Add field pre/post transformer
 - [ ] Remove `fieldTransformer` argument of `Opacker.prepareObjectDeserialize`
+- [ ] Remove `withType` argument of `Opacker.prepareObjectDeserialize`
 
 ### License