com.fasterxml.jackson.annotation

Annotation Type JsonIdentityReference



  • @Target(value={ANNOTATION_TYPE,TYPE,FIELD,METHOD,PARAMETER})
     @Retention(value=RUNTIME)
    public @interface JsonIdentityReference
    Optional annotation that can be used for customizing details of a reference to Objects for which "Object Identity" is enabled (see JsonIdentityInfo). The main use case is that of enforcing use of Object Id even for the first time an Object is referenced, instead of first instance being serialized as full POJO.
    Since:
    2.1
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      boolean alwaysAsId
      Marker to indicate whether all referenced values are to be serialized as ids (true); or by serializing the first encountered reference as POJO and only then as id (false).
    • Element Detail

      • alwaysAsId

        public abstract boolean alwaysAsId
        Marker to indicate whether all referenced values are to be serialized as ids (true); or by serializing the first encountered reference as POJO and only then as id (false).

        Note that if value of 'true' is used, deserialization may require additional contextual information, and possibly using a custom id resolver -- the default handling may not be sufficient.

        Since:
        2.1
        Default:
        false

Copyright © 2008–2024 FasterXML. All rights reserved.