-
Notifications
You must be signed in to change notification settings - Fork 94
/
MapSerializer.java
248 lines (222 loc) · 8.13 KB
/
MapSerializer.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/*
* Copyright (c) 2016, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
package org.eclipse.yasson.internal.serializer;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.Iterator;
import java.util.Map;
import java.util.Optional;
import jakarta.json.bind.serializer.SerializationContext;
import jakarta.json.stream.JsonGenerator;
import org.eclipse.yasson.internal.ReflectionUtils;
/**
* Serialize {@link Map}.
*
* @param <K> {@link Map} key type to serialize
* @param <V> {@link Map} value type to serialize
*/
public class MapSerializer<K, V> extends AbstractContainerSerializer<Map<K, V>> implements EmbeddedItem {
/**
* Internal Map serializing delegate interface.
*
* @param <K> {@link Map} key type to serialize
* @param <V> {@link Map} value type to serialize
*/
interface Delegate<K, V> {
/**
* Process container before serialization begins.
* Does nothing by default.
*
* @param obj item to be serialized
*/
default void beforeSerialize(Map<K, V> obj) {
}
/**
* Write start of an object or an array without a key.
*
* @param generator JSON format generator
*/
void writeStart(JsonGenerator generator);
/**
* Write start of an object or an array with a key.
*
* @param key JSON key name.
* @param generator JSON format generator
*/
void writeStart(String key, JsonGenerator generator);
/**
* Writes end of an object or an array.
*
* @param generator JSON format generator
*/
default void writeEnd(JsonGenerator generator) {
generator.writeEnd();
}
/**
* Serialize content of provided container.
*
* @param obj container to be serialized
* @param generator JSON format generator
* @param ctx JSON serialization context
*/
void serializeContainer(Map<K, V> obj, JsonGenerator generator, SerializationContext ctx);
}
/**
* Whether to serialize null values too.
*/
private final boolean nullable;
private final boolean forceMapArraySerializerForNullKeys;
/**
* Instance that is responsible for serialization.
*/
private Delegate<K, V> serializer;
/**
* Flag to know if the process is for the key (0) or the value (1).
*/
private int actualTypeArgument;
/**
* Creates an instance of {@link Map} serialization.
*
* @param builder current instance of {@link SerializerBuilder}
*/
protected MapSerializer(SerializerBuilder builder) {
super(builder);
actualTypeArgument = 0;
nullable = builder.getJsonbContext().getConfigProperties().getConfigNullable();
forceMapArraySerializerForNullKeys = builder.getJsonbContext().getConfigProperties().isForceMapArraySerializerForNullKeys();
serializer = null;
}
/**
* Check {@link Map} before serialization.
* Decide whether provided {@link Map} can be serialized as {@code JsonObject} or as {@code JsonArray} of map entries.
*
* @param obj {@link Map} to be serialized
*/
@Override
protected void beforeSerialize(Map<K, V> obj) {
if (serializer == null) {
// All keys can be serialized as String
boolean allStrings = true;
// if forceMapArraySerializerForNullKeys is set do not allow map serializer on first null
boolean first = !forceMapArraySerializerForNullKeys;
Class<? extends Object> cls = null;
// Cycle shall exit on first negative check
for (Iterator<? extends Object> i = obj.keySet().iterator(); allStrings && i.hasNext(); ) {
Object key = i.next();
// 2nd and later pass: check whether all Map keys are of the same type
if (cls != null) {
if (key == null) {
allStrings = false;
} else {
allStrings = cls.equals(key.getClass());
}
// 1st pass: check whether key type is supported for Map to JSON Object serialization
} else if (key instanceof String || key instanceof Number || key instanceof Enum) {
cls = key.getClass();
first = false;
// 1st pass: check whether key is null, which is also supported for Map to JSON Object serialization
// Map shall contain only single mapping for null value and nothing else
} else if (key == null && first) {
first = false;
} else {
allStrings = false;
}
}
// Set proper serializing algorithm
if (allStrings) {
serializer = new MapToObjectSerializer<>(this);
} else {
serializer = new MapToEntriesArraySerializer<>(this);
}
}
}
/**
* Serialize content of provided {@link Map}.
* Passing execution to delegate instance.
*
* @param obj {@link Map} to be serialized
* @param generator JSON format generator
* @param ctx JSON serialization context
*/
@Override
protected void serializeInternal(Map<K, V> obj, JsonGenerator generator, SerializationContext ctx) {
serializer.serializeContainer(obj, generator, ctx);
}
/**
* Write start of {@link Map} serialization.
* Passing execution to delegate instance.
*
* @param generator JSON format generator
*/
@Override
protected void writeStart(JsonGenerator generator) {
serializer.writeStart(generator);
}
/**
* Write start of {@link Map} serialization.
* Passing execution to delegate instance.
*
* @param key JSON key name
* @param generator JSON format generator
*/
@Override
protected void writeStart(String key, JsonGenerator generator) {
serializer.writeStart(key, generator);
}
/**
* Write end of {@link Map} serialization.
* Passing execution to delegate instance.
*
* @param generator JSON format generator
*/
@Override
protected void writeEnd(JsonGenerator generator) {
serializer.writeEnd(generator);
}
/**
* Return an information whether to serialize {@code null} values too.
*
* @return {@code null} values shall be serialized too when {@code true}
*/
protected boolean isNullable() {
return nullable;
}
/**
* Flag to serialize the key in the map.
*/
protected void serializeKey() {
this.actualTypeArgument = 0;
}
/**
* Flag to serialize the value in the map.
*/
protected void serializeValue() {
this.actualTypeArgument = 1;
}
/**
* In a map the type can refer to the key or the value type depending which
* one is currently being processed. The field <em>actualTypeArgument</em>
* controls which one is being serialized at the moment.
*
* @param valueType The value type which should be of type Map<K,V>
* @return The type for the key or the value
*/
@Override
protected Type getValueType(Type valueType) {
if (valueType instanceof ParameterizedType && ((ParameterizedType) valueType).getActualTypeArguments().length > actualTypeArgument) {
Optional<Type> runtimeTypeOptional = ReflectionUtils
.resolveOptionalType(this, ((ParameterizedType) valueType).getActualTypeArguments()[actualTypeArgument]);
return runtimeTypeOptional.orElse(Object.class);
}
return Object.class;
}
}