Module tools.jackson.databind
Package tools.jackson.databind.ext.javatime.ser

Class LocalDateSerializer

java.lang.Object
tools.jackson.databind.ValueSerializer<T>
tools.jackson.databind.ser.std.StdSerializer<T>
tools.jackson.databind.ext.javatime.ser.LocalDateSerializer
All Implemented Interfaces:
JsonFormatVisitable
public class LocalDateSerializer extends StdSerializer<T>
Serializer for Java 8 temporal LocalDates.
Author:
Nick Williams

  • Field Details

    • INSTANCE

      public static final LocalDateSerializer INSTANCE

    • _useTimestamp

      protected final Boolean _useTimestamp
      Flag that indicates that serialization must be done as the Java timestamp, regardless of other settings.

    • _useNanoseconds

      protected final Boolean _useNanoseconds
      Flag that indicates that numeric timestamp values must be written using nanosecond timestamps if the datatype supports such resolution, regardless of other settings.

    • _formatter

      protected final DateTimeFormatter _formatter
      Specific format to use, if not default format: non-null value also indicates that serialization is to be done as JSON String, not numeric timestamp, unless #_useTimestamp is true.

    • _shape

      protected final JsonFormat.Shape _shape

    • _integerListType

      protected transient volatile JavaType _integerListType
      Lazily constructed JavaType representing type List<Integer>.
      Since:
      2.10

  • Constructor Details

  • Method Details

    • withFormat

      protected LocalDateSerializer withFormat(DateTimeFormatter dtf, Boolean useTimestamp, JsonFormat.Shape shape)

    • serialize

      public void serialize(LocalDate date, JsonGenerator g, SerializationContext ctxt) throws JacksonException
      Description copied from class: ValueSerializer
      Method that can be called to ask implementation to serialize values of type this serializer handles.
      Specified by:
      serialize in class StdSerializer<LocalDate>
      Parameters:
      date - Value to serialize; can not be null.
      g - Generator used to output resulting Json content
      ctxt - Context that can be used to get serializers for serializing Objects value contains, if any.
      Throws:
      JacksonException

    • serializeWithType

      public void serializeWithType(LocalDate value, JsonGenerator g, SerializationContext ctxt, TypeSerializer typeSer) throws JacksonException
      Description copied from class: ValueSerializer
      Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.

      Default implementation will throw UnsupportedOperationException to indicate that proper type handling needs to be implemented.

      For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look like: 

        // note: method to call depends on whether this type is serialized as JSON scalar, object or Array!
  typeSer.writeTypePrefixForScalar(value, gen);
  serialize(value, gen, provider);
  typeSer.writeTypeSuffixForScalar(value, gen);
      and implementations for type serialized as JSON Arrays or Objects would differ slightly, as START-ARRAY/END-ARRAY and START-OBJECT/END-OBJECT pairs need to be properly handled with respect to serializing of contents.
      Parameters:
      value - Value to serialize; can not be null.
      g - Generator used to output resulting Json content
      ctxt - Context that can be used to get serializers for serializing Objects value contains, if any.
      typeSer - Type serializer to use for including type information
      Throws:
      JacksonException

    • _serializeAsArrayContents

      protected void _serializeAsArrayContents(LocalDate value, JsonGenerator g, SerializationContext ctxt) throws JacksonException
      Throws:
      JacksonException

    • acceptJsonFormatVisitor

      public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
      Description copied from class: StdSerializer
      Default implementation specifies no format. This behavior is usually overriden by custom serializers.
      Specified by:
      acceptJsonFormatVisitor in interface JsonFormatVisitable
      typeHint - Type of element (entity like property) being visited

    • serializationShape

      protected JsonToken serializationShape(SerializationContext ctxt)
      Overridable helper method used from ValueSerializer.serializeWithType(T, tools.jackson.core.JsonGenerator, tools.jackson.databind.SerializationContext, tools.jackson.databind.jsontype.TypeSerializer), to indicate shape of value during serialization; needed to know how type id is to be serialized.

    • withFeatures

      protected tools.jackson.databind.ext.javatime.ser.JSR310FormattedSerializerBase<?> withFeatures(Boolean writeZoneId, Boolean writeNanoseconds)

    • createContextual

      public ValueSerializer<?> createContextual(SerializationContext ctxt, BeanProperty property)
      Description copied from class: ValueSerializer
      Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.

      Note that method is only called once per POJO property, and for the first usage as root value serializer; it is not called for every serialization, as doing that would have significant performance impact; most serializers cache contextual instances for future use.

      Overrides:
      createContextual in class ValueSerializer<T>
      Parameters:
      ctxt - Context to use for accessing config, other serializers
      property - Property (defined by one or more accessors - field or method - used for accessing logical property value) for which serializer is used to be used; or, `null` for root value (or in cases where caller does not have this information, which is handled as root value case).
      Returns:
      Serializer to use for serializing values of specified property; may be this instance or a new instance.

    • _acceptTimestampVisitor

      protected void _acceptTimestampVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)

    • _integerListType

      protected JavaType _integerListType(SerializationContext ctxt)

    • getTimestampsFeature

      protected DateTimeFeature getTimestampsFeature()
      Overridable method that determines SerializationFeature that is used as the global default in determining if date/time value serialized should use numeric format ("timestamp") or not.

      Note that this feature is just the baseline setting and may be overridden on per-type or per-property basis.

      Since:
      2.10

    • useTimestamp

      protected boolean useTimestamp(SerializationContext ctxt)

    • useTimestampFromGlobalDefaults

      protected boolean useTimestampFromGlobalDefaults(SerializationContext ctxt)

    • _useTimestampExplicitOnly

      protected boolean _useTimestampExplicitOnly(SerializationContext ctxt)

    • useNanoseconds

      protected boolean useNanoseconds(SerializationContext ctxt)

    • _useDateTimeFormatter

      protected DateTimeFormatter _useDateTimeFormatter(SerializationContext ctxt, JsonFormat.Value format)