com.fasterxml.jackson.annotation.JsonIgnoreType Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jackson-annotations Show documentation

Core annotations used for value types, used by Jackson data binding package.

There is a newer version: 2.17.0

package com.fasterxml.jackson.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Marker annotation that indicates that all properties that have
 * type annotated with this annotation
 * are to be ignored during serialization and deserialization.
 *
 * Note that this does NOT mean that properties included by annotated
 * type are ignored. Given hypothetical types:
 *
 *  {@code @JsonIgnoreType}
 *  class Credentials {
 *     public String password;
 *  }
 *
 *  class Settings {
 *     public int userId;
 *     public String name;
 *     public Credentials pwd;
 *  }
 *
 * serialization of {@code Settings} would only include properties "userId"
 * and "name" but NOT "pwd", since it is of type annotated with {@code @JsonIgnoreType}.
 *
 * Note: annotation does have boolean 'value' property (which defaults
 * to 'true'), so that it is actually possible to override value
 * using mix-in annotations. Usually value is not specified as it defaults
 * to {@code true} meaning annotation should take effect.
 */
@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonIgnoreType
{
    /**
     * Optional argument that defines whether this annotation is active
     * or not. The only use for value 'false' if for overriding purposes
     * (which is not needed often); most likely it is needed for use
     * with "mix-in annotations" ("annotation overrides").
     * For most cases, however, default value of "true" is just fine
     * and should be omitted.
     */
    boolean value() default true;
}