Annotation Type JsonIgnoreProperties


  • @Target(TYPE)
    @Retention(RUNTIME)
    public @interface JsonIgnoreProperties
    Annotation that can be used to either suppress serialization of properties (during serialization), or ignore processing of JSON properties read (during deserialization).

    Example:

     // to prevent specified fields from being serialized or deserialized
     // (i.e. not include in JSON output; or being set even if they were included)
     \@JsonIgnoreProperties({ "internalId", "secretKey" })
     // To ignore any unknown properties in JSON input without exception:
     \@JsonIgnoreProperties(ignoreUnknown=true)
    

    Only applicable to classes, not for properties (getters, setters, fields).

    Since:
    1.4
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean ignoreUnknown
      Property that defines whether it is ok to just ignore any unrecognized properties during deserialization.
      String[] value
      Names of properties to ignore.
    • Element Detail

      • value

        String[] value
        Names of properties to ignore.
        Default:
        {}
      • ignoreUnknown

        boolean ignoreUnknown
        Property that defines whether it is ok to just ignore any unrecognized properties during deserialization. If true, all properties that are unrecognized -- that is, there are no setters or creators that accept them -- are ignored without warnings (although handlers for unknown properties, if any, will still be called) without exception.

        Does not have any effect on serialization.

        Default:
        false