com.fasterxml.jackson.annotation

Annotation Type JsonInclude

@Target(value={ANNOTATION_TYPE,METHOD,FIELD,TYPE,PARAMETER})
@Retention(value=RUNTIME)
public @interface JsonInclude

Annotation used to indicate when value of the annotated property (when used for a field, method or constructor parameter), or all properties of the annotated class, is to be serialized. Without annotation property values are always included, but by using this annotation one can specify simple exclusion rules to reduce amount of properties to write out.

Note that inclusion criteria is checked on Java object level and NOT on JSON output -- so even with JsonInclude.Include.NON_NULL it is possible that JSON null values are output, if object reference in question is not `null`. An example is AtomicReference instance constructed to reference null value: such a value would be serialized as JSON null, and not filtered out. In such cases JsonInclude.Include.NON_EMPTY should be used instead, since missing reference (that is, reference to Java null) is considered "empty" (it is also considered "default", so match JsonInclude.Include.NON_DEFAULT).

Since:

2.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
JsonInclude.Include	content Inclusion rule to use for entries ("content") of annotated Maps; defaults to JsonInclude.Include.ALWAYS.
JsonInclude.Include	value Inclusion rule to use for instances (values) of types (Classes) or properties annotated.

Element Detail

value

public abstract JsonInclude.Include value

Inclusion rule to use for instances (values) of types (Classes) or properties annotated.

Default:

com.fasterxml.jackson.annotation.JsonInclude.Include.ALWAYS

content

public abstract JsonInclude.Include content

Inclusion rule to use for entries ("content") of annotated Maps; defaults to JsonInclude.Include.ALWAYS.

Since:

2.5

Default:

com.fasterxml.jackson.annotation.JsonInclude.Include.ALWAYS