Module tools.jackson.databind
Package tools.jackson.databind.ser.jdk

Class DateTimeSerializerBase<T>

java.lang.Object
tools.jackson.databind.ValueSerializer<T>
tools.jackson.databind.ser.std.StdSerializer<T>
tools.jackson.databind.ser.std.StdScalarSerializer<T>
tools.jackson.databind.ser.jdk.DateTimeSerializerBase<T>
All Implemented Interfaces:
JsonFormatVisitable
Direct Known Subclasses:
JavaSqlDateSerializer, JavaUtilCalendarSerializer, JavaUtilDateSerializer
public abstract class DateTimeSerializerBase<T> extends StdScalarSerializer<T>

  • Field Details

    • _useTimestamp

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

    • _customFormat

      protected final DateFormat _customFormat
      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.

    • _reusedCustomFormat

      protected final AtomicReference<DateFormat> _reusedCustomFormat
      If _customFormat is used, we will try to reuse instances in simplest possible form; thread-safe, but without overhead of ThreadLocal (not from code, but wrt retaining of possibly large number of format instances over all threads, properties with custom formats).
      Since:
      2.9

  • Constructor Details

    • DateTimeSerializerBase

      protected DateTimeSerializerBase(Class<T> type, Boolean useTimestamp, DateFormat customFormat)

  • Method Details

    • withFormat

      public abstract DateTimeSerializerBase<T> withFormat(Boolean timestamp, DateFormat customFormat)

    • createContextual

      public ValueSerializer<?> createContextual(SerializationContext serializers, 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:
      serializers - 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.

    • isEmpty

      public boolean isEmpty(SerializationContext serializers, T value)
      Description copied from class: ValueSerializer
      Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).

      Default implementation will consider only null values to be empty.

      Overrides:
      isEmpty in class ValueSerializer<T>

    • _timestamp

      protected abstract long _timestamp(T value)

    • 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
      Overrides:
      acceptJsonFormatVisitor in class StdScalarSerializer<T>
      typeHint - Type of element (entity like property) being visited

    • serialize

      public abstract void serialize(T value, JsonGenerator gen, SerializationContext serializers) 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<T>
      Parameters:
      value - Value to serialize; can not be null.
      gen - Generator used to output resulting Json content
      serializers - Context that can be used to get serializers for serializing Objects value contains, if any.
      Throws:
      JacksonException

    • _asTimestamp

      protected boolean _asTimestamp(SerializationContext serializers)

    • _acceptJsonFormatVisitor

      protected void _acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint, boolean asNumber)

    • _serializeAsString

      protected void _serializeAsString(Date value, JsonGenerator g, SerializationContext provider) throws JacksonException
      Throws:
      JacksonException