Skip to content

Commit f5f823b

Browse files
authored
add javadoc about key (de)serializers (#4673)
1 parent 3862a3d commit f5f823b

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

src/main/java/com/fasterxml/jackson/databind/Module.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,7 @@ public static interface SetupContext
197197
*
198198
* @param d Object that can be called to find deserializer for types supported
199199
* by module (null returned for non-supported types)
200+
* @see #addKeyDeserializers is used to register key deserializers (for Map keys)
200201
*/
201202
public void addDeserializers(Deserializers d);
202203

@@ -213,6 +214,7 @@ public static interface SetupContext
213214
*
214215
* @param s Object that can be called to find serializer for types supported
215216
* by module (null returned for non-supported types)
217+
* @see #addKeySerializers is used to register key serializers (for Map keys)
216218
*/
217219
public void addSerializers(Serializers s);
218220

src/main/java/com/fasterxml/jackson/databind/module/SimpleModule.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,7 @@ protected SimpleModule setNamingStrategy(PropertyNamingStrategy naming) {
321321
* Possible earlier addition of a serializer for a given Class will be replaced.
322322
* <p>
323323
* NOTE: This method registers "default" (de)serializers only. See a note on precedence in class JavaDoc.
324+
* @see #addKeySerializer(Class, JsonSerializer) is used to register key serializers (for Map keys)
324325
*/
325326
public SimpleModule addSerializer(JsonSerializer<?> ser)
326327
{
@@ -345,6 +346,7 @@ public SimpleModule addSerializer(JsonSerializer<?> ser)
345346
* Possible earlier addition of a serializer for a given Class will be replaced.
346347
* <p>
347348
* NOTE: This method registers "default" (de)serializers only. See a note on precedence in class JavaDoc.
349+
* @see #addKeySerializer(Class, JsonSerializer) is used to register key serializers (for Map keys)
348350
*/
349351
public <T> SimpleModule addSerializer(Class<? extends T> type, JsonSerializer<T> ser)
350352
{
@@ -388,6 +390,7 @@ public <T> SimpleModule addKeySerializer(Class<? extends T> type, JsonSerializer
388390
* Possible earlier addition of a serializer for a given Class will be replaced.
389391
* <p>
390392
* NOTE: This method registers "default" (de)serializers only. See a note on precedence in class JavaDoc.
393+
* @see #addKeyDeserializer(Class, KeyDeserializer) is used to register key deserializers (for Map keys)
391394
*/
392395
public <T> SimpleModule addDeserializer(Class<T> type, JsonDeserializer<? extends T> deser)
393396
{

0 commit comments

Comments
 (0)