Class DurationSerializer

java.lang.Object

tools.jackson.databind.ValueSerializer<Duration>

tools.jackson.databind.ser.std.StdSerializer<Duration>

tools.jackson.databind.ext.javatime.ser.JSR310SerializerBase<Duration>

tools.jackson.databind.ext.javatime.ser.JSR310FormattedSerializerBase<Duration>

tools.jackson.databind.ext.javatime.ser.DurationSerializer

All Implemented Interfaces:

JsonFormatVisitable

public class DurationSerializer
extends JSR310FormattedSerializerBase<Duration>

Serializer for Java 8 temporal Durations.

NOTE: since 2.10, DateTimeFeature.WRITE_DURATIONS_AS_TIMESTAMPS determines global default used for determining if serialization should use numeric (timestamps) or textual representation. Before this, DateTimeFeature.WRITE_DATES_AS_TIMESTAMPS was used.

Nested Class Summary

Nested classes/interfaces inherited from class ValueSerializer

ValueSerializer.None

Field Summary

Fields

Modifier and Type	Field	Description
private DurationUnitConverter	_durationUnitConverter	When defined (not null) duration values will be converted into integers with the unit configured for the converter.
static final DurationSerializer	INSTANCE

Fields inherited from class JSR310FormattedSerializerBase

_formatter, _integerListType, _shape, _useNanoseconds, _useTimestamp

Fields inherited from class StdSerializer

_handledType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DurationSerializer()
protected	DurationSerializer(DurationSerializer base, DateTimeFormatter dtf, Boolean useTimestamp)
protected	DurationSerializer(DurationSerializer base, DateTimeFormatter dtf, Boolean useTimestamp, Boolean useNanoseconds)
protected	DurationSerializer(DurationSerializer base, DurationUnitConverter converter)

Method Summary

Modifier and Type	Method	Description
protected void	_acceptTimestampVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
private BigDecimal	_toNanos(Duration duration)
protected DateTimeFormatter	_useDateTimeFormatter(SerializationContext ctxt, com.fasterxml.jackson.annotation.JsonFormat.Value format)
ValueSerializer<?>	createContextual(SerializationContext ctxt, BeanProperty property)	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).
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.
protected tools.jackson.core.JsonToken	serializationShape(SerializationContext ctxt)	Overridable helper method used from JSR310SerializerBase.serializeWithType(T, JsonGenerator, SerializationContext, TypeSerializer), to indicate shape of value during serialization; needed to know how type id is to be serialized.
void	serialize(Duration duration, tools.jackson.core.JsonGenerator generator, SerializationContext ctxt)	Method that can be called to ask implementation to serialize values of type this serializer handles.
protected DurationSerializer	withConverter(DurationUnitConverter converter)
protected JSR310FormattedSerializerBase<?>	withFeatures(Boolean writeZoneId, Boolean writeNanoseconds)
protected DurationSerializer	withFormat(DateTimeFormatter dtf, Boolean useTimestamp, com.fasterxml.jackson.annotation.JsonFormat.Shape shape)

Methods inherited from class JSR310FormattedSerializerBase

_integerListType, _useTimestampExplicitOnly, acceptJsonFormatVisitor, useNanoseconds, useTimestamp, useTimestampFromGlobalDefaults

Methods inherited from class JSR310SerializerBase

serializeWithType

Methods inherited from class StdSerializer

_neitherNull, _nonEmpty, _wrapIOFailure, acceptJsonFormatVisitorForBinary, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow

Methods inherited from class ValueSerializer

getDelegatee, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, resolve, unwrappingSerializer, usesObjectId, withFilterId, withFormatOverrides, withIgnoredProperties

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INSTANCE

public static final DurationSerializer INSTANCE

_durationUnitConverter

private DurationUnitConverter _durationUnitConverter

When defined (not null) duration values will be converted into integers with the unit configured for the converter. Only available when

invalid reference

SerializationFeature#WRITE_DURATIONS_AS_TIMESTAMPS

is enabled and

invalid reference

SerializationFeature#WRITE_DATE_TIMESTAMPS_AS_NANOSECONDS

is not enabled since the duration converters do not support fractions

Constructor Details

DurationSerializer

protected DurationSerializer()

DurationSerializer

protected DurationSerializer(DurationSerializer base,
 DateTimeFormatter dtf,
 Boolean useTimestamp)

DurationSerializer

protected DurationSerializer(DurationSerializer base,
 DateTimeFormatter dtf,
 Boolean useTimestamp,
 Boolean useNanoseconds)

DurationSerializer

protected DurationSerializer(DurationSerializer base,
 DurationUnitConverter converter)

Method Details

withFormat

protected DurationSerializer withFormat(DateTimeFormatter dtf,
 Boolean useTimestamp,
 com.fasterxml.jackson.annotation.JsonFormat.Shape shape)

Specified by:

withFormat in class JSR310FormattedSerializerBase<Duration>

withConverter

protected DurationSerializer withConverter(DurationUnitConverter converter)

getTimestampsFeature

protected DateTimeFeature getTimestampsFeature()

Description copied from class: JSR310FormattedSerializerBase

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.

Overrides:

getTimestampsFeature in class JSR310FormattedSerializerBase<Duration>

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 JSR310FormattedSerializerBase<Duration>

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.

serialize

public void serialize(Duration duration,
 tools.jackson.core.JsonGenerator generator,
 SerializationContext ctxt)
               throws tools.jackson.core.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<Duration>

Parameters:

duration - Value to serialize; can not be null.

generator - Generator used to output resulting Json content

ctxt - Context that can be used to get serializers for serializing Objects value contains, if any.

Throws:

tools.jackson.core.JacksonException

_toNanos

private BigDecimal _toNanos(Duration duration)

_acceptTimestampVisitor

protected void _acceptTimestampVisitor(JsonFormatVisitorWrapper visitor,
 JavaType typeHint)

Overrides:

_acceptTimestampVisitor in class JSR310FormattedSerializerBase<Duration>

serializationShape

protected tools.jackson.core.JsonToken serializationShape(SerializationContext ctxt)

Description copied from class: JSR310SerializerBase

Overridable helper method used from JSR310SerializerBase.serializeWithType(T, JsonGenerator, SerializationContext, TypeSerializer), to indicate shape of value during serialization; needed to know how type id is to be serialized.

Specified by:

serializationShape in class JSR310SerializerBase<Duration>

withFeatures

protected JSR310FormattedSerializerBase<?> withFeatures(Boolean writeZoneId,
 Boolean writeNanoseconds)

Overrides:

withFeatures in class JSR310FormattedSerializerBase<Duration>

_useDateTimeFormatter

protected DateTimeFormatter _useDateTimeFormatter(SerializationContext ctxt,
 com.fasterxml.jackson.annotation.JsonFormat.Value format)

Overrides:

_useDateTimeFormatter in class JSR310FormattedSerializerBase<Duration>