Skip to content

Commit 444aee8

Browse files
committed
Update README.
1 parent ed08cc4 commit 444aee8

File tree

2 files changed

+70
-30
lines changed

2 files changed

+70
-30
lines changed

README.in

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,43 @@ Create a restricted serializer that is permitted to deserialize only the
3535
given classes and no others, and then register it with a mapper:
3636

3737
```
38-
var serializers =
39-
DmJsonRestrictedDeserializers.builder()
40-
.allowClass(Optional.class)
41-
.allowClass(Path.class)
42-
.allowClass(String.class)
43-
.allowClass(URI.class)
44-
.allowClass(int.class)
45-
.allowClass(double.class)
46-
.allowClass(List.class)
47-
.allowClassName(
48-
"java.util.Optional<java.lang.Integer>")
49-
.allowClassName(
50-
"java.util.List<java.lang.String>")
51-
.build();
38+
var builder =
39+
DmJsonRestrictedDeserializers.builder();
40+
41+
// Allow deserializing values of various "value" classes...
42+
builder.allowClass(Path.class)
43+
.allowClass(String.class)
44+
.allowClass(URI.class)
45+
.allowClass(int.class)
46+
.allowClass(double.class);
47+
48+
// Allow java.util.Optional<java.lang.Integer>
49+
builder.allowOptionalOfClass(Integer.class);
50+
51+
// Or, equivalently:
52+
builder.allowClassName("java.util.Optional<java.lang.Integer>")
53+
54+
// Allow java.util.List<java.lang.String>
55+
builder.allowListsOfClass(String.class);
56+
57+
// Or, equivalently:
58+
builder.allowClassName("java.util.List<java.lang.String>");
59+
60+
// Allow java.util.Set<java.lang.String>
61+
builder.allowSetsOfClass(String.class);
62+
63+
// Or, equivalently:
64+
builder.allowClassName("java.util.Set<java.lang.String>");
65+
66+
// Allow java.util.Map<java.lang.Integer, java.lang.String>
67+
builder.allowMapsOfClass(Integer.class, String.class);
68+
69+
// Or, equivalently:
70+
builder.allowClassName("java.util.Map<java.lang.Integer, java.lang.String>");
5271

72+
final var serializers = builder.build();
5373
final var simpleModule = new SimpleModule();
54-
simpleModule.setDeserializers(this.serializers);
74+
simpleModule.setDeserializers(serializers);
5575

5676
final var mapper =
5777
JsonMapper.builder()

README.md

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -51,23 +51,43 @@ Create a restricted serializer that is permitted to deserialize only the
5151
given classes and no others, and then register it with a mapper:
5252

5353
```
54-
var serializers =
55-
DmJsonRestrictedDeserializers.builder()
56-
.allowClass(Optional.class)
57-
.allowClass(Path.class)
58-
.allowClass(String.class)
59-
.allowClass(URI.class)
60-
.allowClass(int.class)
61-
.allowClass(double.class)
62-
.allowClass(List.class)
63-
.allowClassName(
64-
"java.util.Optional<java.lang.Integer>")
65-
.allowClassName(
66-
"java.util.List<java.lang.String>")
67-
.build();
54+
var builder =
55+
DmJsonRestrictedDeserializers.builder();
56+
57+
// Allow deserializing values of various "value" classes...
58+
builder.allowClass(Path.class)
59+
.allowClass(String.class)
60+
.allowClass(URI.class)
61+
.allowClass(int.class)
62+
.allowClass(double.class);
63+
64+
// Allow java.util.Optional<java.lang.Integer>
65+
builder.allowOptionalOfClass(Integer.class);
66+
67+
// Or, equivalently:
68+
builder.allowClassName("java.util.Optional<java.lang.Integer>")
69+
70+
// Allow java.util.List<java.lang.String>
71+
builder.allowListsOfClass(String.class);
72+
73+
// Or, equivalently:
74+
builder.allowClassName("java.util.List<java.lang.String>");
75+
76+
// Allow java.util.Set<java.lang.String>
77+
builder.allowSetsOfClass(String.class);
78+
79+
// Or, equivalently:
80+
builder.allowClassName("java.util.Set<java.lang.String>");
81+
82+
// Allow java.util.Map<java.lang.Integer, java.lang.String>
83+
builder.allowMapsOfClass(Integer.class, String.class);
84+
85+
// Or, equivalently:
86+
builder.allowClassName("java.util.Map<java.lang.Integer, java.lang.String>");
6887
88+
final var serializers = builder.build();
6989
final var simpleModule = new SimpleModule();
70-
simpleModule.setDeserializers(this.serializers);
90+
simpleModule.setDeserializers(serializers);
7191
7292
final var mapper =
7393
JsonMapper.builder()

0 commit comments

Comments
 (0)