Jackson-annotations 2.16.0 · com.fasterxml.jackson.annotation.JsonFormat

General-purpose annotation used for configuring details of how values of properties are to be serialized. Unlike most other Jackson annotations, annotation does not have specific universal interpretation: instead, effect depends on datatype of property being annotated (or more specifically, deserializer and serializer being used).

Common uses include choosing between alternate representations -- for example, whether java.util.Date is to be serialized as number (Java timestamp) or String (such as ISO-8601 compatible time value) -- as well as configuring exact details with pattern property.

As of Jackson 2.6, known special handling includes:

java.util.Date: Shape can be Shape#STRING or Shape#NUMBER; pattern may contain java.text.SimpleDateFormat-compatible pattern definition.
Can be used on Classes (types) as well, for modified default behavior, possibly overridden by per-property annotation
java.lang.Enums: Shapes Shape#STRING and Shape#NUMBER can be used to change between numeric (index) and textual (name or toString()); but it is also possible to use Shape#OBJECT to serialize (but not deserialize) java.lang.Enums as JSON Objects (as if they were POJOs). NOTE: serialization as JSON Object only works with class annotation; will not work as per-property annotation.
java.util.Collections can be serialized as (and deserialized from) JSON Objects, if Shape#OBJECT is used. NOTE: can ONLY be used as class annotation; will not work as per-property annotation.
java.lang.Number subclasses can be serialized as full objects if Shape#OBJECT is used. Otherwise the default behavior of serializing to a scalar number value will be preferred. NOTE: can ONLY be used as class annotation; will not work as per-property annotation.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	JsonFormat.Feature Set of features that can be enabled/disabled for property annotated.
public static class	JsonFormat.Features Helper class that encapsulates information equivalent to `java.lang.Boolean` valued `java.util.EnumMap`.
public static enum	JsonFormat.Shape Value enumeration used for indicating preferred Shape; translates loosely to JSON types, with some extra values to indicate less precise choices (i.e. allowing one of multiple actual shapes)
public static class	JsonFormat.Value Helper class used to contain information from a single `JsonFormat` annotation.

Field Summary

Modifier and Type	Field and Description
public static final String	DEFAULT_LOCALE Value that indicates that default `java.util.Locale` (from deserialization or serialization context) should be used: annotation does not define value to use.
public static final String	DEFAULT_TIMEZONE Value that indicates that default `java.util.TimeZone` (from deserialization or serialization context) should be used: annotation does not define value to use.

Method Summary

Modifier and Type	Method and Description
public OptBoolean	lenient() Property that indicates whether "lenient" handling should be enabled or disabled.
public String	locale() `java.util.Locale` to use for serialization (if needed).
public String	pattern() Datatype-specific additional piece of configuration that may be used to further refine formatting aspects.
public JsonFormat.Shape	shape() Structure to use for serialization: definition of mapping depends on datatype, but usually has straight-forward counterpart in data format (JSON).
public String	timezone() `java.util.TimeZone` to use for serialization (if needed).
public JsonFormat.Feature[]	with() Set of `JsonFormat.Feature`s to explicitly enable with respect to handling of annotated property.
public JsonFormat.Feature[]	without() Set of `JsonFormat.Feature`s to explicitly disable with respect to handling of annotated property.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

public @Interface JsonFormat

Nested and Inner Type Summary

Field Summary

Method Summary