Skip to content

Commit da0b428

Browse files
committed
README.md additions
1 parent b03c872 commit da0b428

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,28 @@ Speed improvement is achieved by idea of Proxy pattern, where objects are create
99

1010
## Examples of use
1111

12+
#### Deserialization
13+
🔥 New feature (v0.5). Deserialization to objects.
14+
15+
Full source code on [iris/json/test/serialization.kt](https://github.com/iris2iris/iris-json-parser-kotlin/blob/master/src/iris/json/test/serialization.kt)
16+
````kotlin
17+
val item = IrisJsonParser("""{"id": 3,
18+
|"person1": {"name": "Akbar", "age": 35, "cashAmount": 12200.12, "property": {"name": "Домик в деревне"}},
19+
|"type": "MaleFirst",
20+
|"person2": {"name": "Alla Who", "height": 170, "income": 1214.81}
21+
|}""".trimMargin()).parse()
22+
23+
val user: User = item.asObject(User::class)
24+
println(user.person1)
25+
println(user.person2)
26+
````
27+
1228
#### Flow pre-parse
13-
🔥 New feature (v0.3). Flow preparing JSON-tree information only until required field.
29+
Interesting feature (v0.3). Flow preparing JSON-tree information only until required field.
1430

1531
Useful when required fields are located at first part of JSON string.
1632

17-
```Kotlin
33+
```kotlin
1834
val testString = File("test.json").readText()
1935

2036
// Demonstration of functional abilities
@@ -44,7 +60,7 @@ println("To Double: " + obj.find("object.message.attachments[0].wall.id").asDoub
4460
#### Full pre-parse
4561
Prepares full JSON-tree information. Useful when lots of fields are requested.
4662

47-
```Kotlin
63+
```kotlin
4864
// Demonstration of functional abilities
4965
val parser = IrisJsonParser(testString)
5066
val res = parser.parse() // parsed to IrisJsonItem's
@@ -73,7 +89,7 @@ println("To Double: " + res.find("object.message.attachments[0].wall.id").asDoub
7389
## Performance test
7490

7591
#### Array of 50 elements
76-
Test code is in [iris/json/flow/test/performance_array.kt](https://github.com/iris2iris/iris-json-parser-kotlin/blob/master/src/iris/json/flow/test/performance_array.kt) file.
92+
Test code is in [iris/json/test/performance_array.kt](https://github.com/iris2iris/iris-json-parser-kotlin/blob/master/src/iris/json/test/performance_array.kt) file.
7793

7894
Test JSON file is in [test_array.json](https://github.com/iris2iris/iris-json-parser-kotlin/blob/master/test_array.json) file.
7995

@@ -98,7 +114,7 @@ POJO: 10
98114

99115
#### Complex json-tree structure
100116

101-
Test code is in [iris/json/flow/test/performance_object_tree.kt](https://github.com/iris2iris/iris-json-parser-kotlin/blob/master/src/iris/json/flow/test/performance_object_tree.kt) file.
117+
Test code is in [iris/json/test/performance_object_tree.kt](https://github.com/iris2iris/iris-json-parser-kotlin/blob/master/src/iris/json/test/performance_object_tree.kt) file.
102118

103119
Test JSON file is in [test.json](https://github.com/iris2iris/iris-json-parser-kotlin/blob/master/test.json) file.
104120

0 commit comments

Comments
 (0)