Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  package com.fasterxml.jackson.databind.annotation;
  
  
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
  )

 
 public @interface JsonDeserialize
 {
     // // // Annotations for explicitly specifying deserialize/builder
 
    
Deserializer 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 property access via a setter method.
 
     public Class<? extends JsonDeserializer<?>> using()
         default JsonDeserializer.None.class;

    
Deserializer class to use for deserializing contents (elements of a Collection/array, values of Maps) of annotated property. Can only be used on instances (methods, fields, constructors), and not value classes themselves.
 
     public Class<? extends JsonDeserializer<?>> contentUsing()
         default JsonDeserializer.None.class;

    
Deserializer class to use for deserializing Map keys of annotated property. Can only be used on instances (methods, fields, constructors), and not value classes themselves.
 
     public Class<? extends KeyDeserializerkeyUsing()
         default KeyDeserializer.None.class;

    
Annotation 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.
 
     public Class<?> builder()
         default NoClass.class;
 
     // // // Annotations for specifying intermediate Converters (2.2+)
     
    
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
 
     public Class<? extends Converter<?,?>> converter() default Converter.None.class;

    
Similar to converter, but used for values of structures types (List, arrays, Maps).

Since:
2.2
 
     public Class<? extends Converter<?,?>> contentConverter() default Converter.None.class;
     
     
     // // // Annotations for explicitly specifying deserialization type
     // // // (which is used for choosing deserializer, if not explicitly
    // // // specified

    
Concrete 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 NoClass 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.

    public Class<?> as() default NoClass.class;

    
Concrete type to deserialize keys of java.util.Map as, instead of type otherwise declared. Must be a subtype of declared type; otherwise an exception may be thrown by deserializer.
    public Class<?> keyAs() default NoClass.class;

    
Concrete 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.
    public Class<?> contentAs() default NoClass.class;
New to GrepCode? Check out our FAQ X