Annotation Interface JsonDeserialize
@Target({ANNOTATION_TYPE,METHOD,FIELD,TYPE,PARAMETER})
@Retention(RUNTIME)
public @interface JsonDeserialize
Annotation use for configuring deserialization aspects, by attaching
to "setter" methods or fields, or to value classes.
When annotating value classes, configuration is used for instances
of the value class but can be overridden by more specific annotations
(ones that attach to methods or fields).
An example annotation would be:
@JsonDeserialize(using=MySerializer.class, as=MyHashMap.class, keyAs=MyHashKey.class, contentAs=MyHashValue.class )
Something to note on usage:
- All other annotations regarding behavior during building should be on Builder class and NOT on target POJO class: for example @JsonIgnoreProperties should be on Builder to prevent "unknown property" errors.
- Similarly configuration overrides (see
ObjectMapper.configOverride(java.lang.Class<?>)
) should be targeted at Builder class, not target POJO class.
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionClass<?>
Concrete type to deserialize values as, instead of type otherwise declared.Class<?>
Annotation for specifying if an external Builder class is to be used for building up deserialized instances of annotated class.Class<?>
Concrete type to deserialize content (elements of a Collection/array, values of Maps) values as, instead of type otherwise declared.Similar toconverter()
, but used for values of structures types (List, arrays, Maps).Class<? extends JsonDeserializer>
Deserializer class to use for deserializing contents (elements of a Collection/array, values of Maps) of annotated property.Which helper object (if any) is to be used to convert from Jackson-bound intermediate type (source type of converter) into actual property type (which must be same as result type of converter).Class<?>
Concrete type to deserialize keys ofMap
as, instead of type otherwise declared.Class<? extends KeyDeserializer>
Deserializer class to use for deserializing Map keys of annotated property or Map keys of value type so annotated.Class<? extends JsonDeserializer>
Deserializer class to use for deserializing associated value.
-
Element Details
-
using
Class<? extends JsonDeserializer> usingDeserializer class to use for deserializing associated value. Depending on what is annotated, value is either an instance of annotated class (used globablly anywhere where class deserializer is needed); or only used for deserializing the value of the property annotated.- Default:
- edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonDeserializer.None.class
-
contentUsing
Class<? extends JsonDeserializer> contentUsingDeserializer class to use for deserializing contents (elements of a Collection/array, values of Maps) of annotated property. Can only be used on accessors (methods, fields, constructors), to apply to values ofMap
-valued properties; not applicable for value types used as Array elements orCollection
andMap
values.- Default:
- edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonDeserializer.None.class
-
keyUsing
Class<? extends KeyDeserializer> keyUsingDeserializer class to use for deserializing Map keys of annotated property or Map keys of value type so annotated. Can be used both on accessors (methods, fields, constructors), to apply to values ofMap
-valued properties, and on "key" classes, to apply to use of annotated type asMap
keys (latter starting with Jackson 2.11).- Default:
- edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.KeyDeserializer.None.class
-
builder
Class<?> builderAnnotation for specifying if an external Builder class is to be used for building up deserialized instances of annotated class. If so, an instance of referenced class is first constructed (possibly using a Creator method; or if none defined, using default constructor), and its "with-methods" are used for populating fields; and finally "build-method" is invoked to complete deserialization.- Default:
- java.lang.Void.class
-
converter
Which helper object (if any) is to be used to convert from Jackson-bound intermediate type (source type of converter) into actual property type (which must be same as result type of converter). This is often used for two-step deserialization; Jackson binds data into suitable intermediate type (like Tree representation), and converter then builds actual property type.- Since:
- 2.2
- Default:
- edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.util.Converter.None.class
-
contentConverter
Similar toconverter()
, but used for values of structures types (List, arrays, Maps).- Since:
- 2.2
- Default:
- edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.util.Converter.None.class
-
as
Class<?> asConcrete type to deserialize values as, instead of type otherwise declared. Must be a subtype of declared type; otherwise an exception may be thrown by deserializer.Bogus type
Void
can be used to indicate that declared type is used as is (i.e. this annotation property has no setting); this since annotation properties are not allowed to have null value.Note: if
using()
is also used it has precedence (since it directly specified deserializer, whereas this would only be used to locate the deserializer) and value of this annotation property is ignored.- Default:
- java.lang.Void.class
-
keyAs
Class<?> keyAsConcrete type to deserialize keys ofMap
as, instead of type otherwise declared. Must be a subtype of declared type; otherwise an exception may be thrown by deserializer.- Default:
- java.lang.Void.class
-
contentAs
Class<?> contentAsConcrete type to deserialize content (elements of a Collection/array, values of Maps) values as, instead of type otherwise declared. Must be a subtype of declared type; otherwise an exception may be thrown by deserializer.- Default:
- java.lang.Void.class
-