Package com.fasterxml.jackson.datatype.jsr310.ser

Class DurationSerializer

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializer<T>

com.fasterxml.jackson.databind.ser.std.StdSerializer<T>

com.fasterxml.jackson.datatype.jsr310.ser.DurationSerializer

All Implemented Interfaces:

JsonFormatVisitable, SchemaAware, ContextualSerializer, Serializable

public class DurationSerializer
extends StdSerializer<T>

Serializer for Java 8 temporal Durations.

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

Since:

2.2

Author:

Nick Williams

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonSerializer

JsonSerializer.None

Field Summary

Fields

Modifier and Type	Field	Description
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.
protected JavaType	_integerListType	Lazily constructed JavaType representing type List<Integer>.
protected final JsonFormat.Shape	_shape
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.
protected final Boolean	_useTimestamp	Flag that indicates that serialization must be done as the Java timestamp, regardless of other settings.
static final DurationSerializer	INSTANCE

Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

_handledType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	_acceptTimestampVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
protected JavaType	_integerListType(SerializerProvider prov)
protected DateTimeFormatter	_useDateTimeFormatter(SerializerProvider prov, JsonFormat.Value format)
protected boolean	_useTimestampExplicitOnly(SerializerProvider provider)
void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)	Default implementation specifies no format.
JsonSerializer<?>	createContextual(SerializerProvider prov, BeanProperty property)	Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.
JsonNode	getSchema(SerializerProvider provider, Type typeHint)	Deprecated. Since 2.15
protected SerializationFeature	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 JsonToken	serializationShape(SerializerProvider provider)	Overridable helper method used from JsonSerializer.serializeWithType(T, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider, com.fasterxml.jackson.databind.jsontype.TypeSerializer), to indicate shape of value during serialization; needed to know how type id is to be serialized.
void	serialize(Duration duration, JsonGenerator generator, SerializerProvider provider)	Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeWithType(Duration value, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer)	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.
protected boolean	useNanoseconds(SerializerProvider provider)
protected boolean	useTimestamp(SerializerProvider provider)
protected DurationSerializer	withConverter(DurationUnitConverter converter)
protected com.fasterxml.jackson.datatype.jsr310.ser.JSR310FormattedSerializerBase<?>	withFeatures(Boolean writeZoneId)	Deprecated.
protected com.fasterxml.jackson.datatype.jsr310.ser.JSR310FormattedSerializerBase<?>	withFeatures(Boolean writeZoneId, Boolean writeNanoseconds)
protected DurationSerializer	withFormat(Boolean useTimestamp, DateTimeFormatter dtf, JsonFormat.Shape shape)

Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

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

Methods inherited from class com.fasterxml.jackson.databind.JsonSerializer

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

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final DurationSerializer 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

DurationSerializer

protected DurationSerializer()

DurationSerializer

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

DurationSerializer

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

DurationSerializer

protected DurationSerializer(DurationSerializer base,
 DurationUnitConverter converter)

Method Details

withFormat

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

withConverter

protected DurationSerializer withConverter(DurationUnitConverter converter)

getTimestampsFeature

protected SerializationFeature 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.

createContextual

public JsonSerializer<?> createContextual(SerializerProvider prov,
 BeanProperty property)
                                   throws JsonMappingException

Description copied from interface: ContextualSerializer

Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. 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.

Specified by:

createContextual in interface ContextualSerializer

Parameters:

prov - Serializer provider to use for accessing config, other serializers

property - Method or field that represents the property (and is used to access value to serialize). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' serializer as is)

Returns:

Serializer to use for serializing values of specified property; may be this instance or a new instance.

Throws:

JsonMappingException

serialize

public void serialize(Duration duration,
 JsonGenerator generator,
 SerializerProvider provider)
               throws IOException

Description copied from class: JsonSerializer

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

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

Throws:

IOException

_acceptTimestampVisitor

protected void _acceptTimestampVisitor(JsonFormatVisitorWrapper visitor,
 JavaType typeHint)
                                throws JsonMappingException

Throws:

JsonMappingException

serializationShape

protected JsonToken serializationShape(SerializerProvider provider)

Overridable helper method used from JsonSerializer.serializeWithType(T, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider, com.fasterxml.jackson.databind.jsontype.TypeSerializer), to indicate shape of value during serialization; needed to know how type id is to be serialized.

withFeatures

protected com.fasterxml.jackson.datatype.jsr310.ser.JSR310FormattedSerializerBase<?> withFeatures(Boolean writeZoneId,
 Boolean writeNanoseconds)

_useDateTimeFormatter

protected DateTimeFormatter _useDateTimeFormatter(SerializerProvider prov,
 JsonFormat.Value format)

withFeatures

@Deprecated
protected com.fasterxml.jackson.datatype.jsr310.ser.JSR310FormattedSerializerBase<?> withFeatures(Boolean writeZoneId)

Deprecated.

Since:

2.8

getSchema

@Deprecated
public JsonNode getSchema(SerializerProvider provider,
 Type typeHint)

Deprecated.

Since 2.15

Description copied from class: StdSerializer

Default implementation simply claims type is "string"; usually overriden by custom serializers.

Specified by:

getSchema in interface SchemaAware

Overrides:

getSchema in class StdSerializer<T>

Parameters:

provider - The serializer provider.

typeHint - A hint about the type.

Returns:

Json-schema for this serializer.

acceptJsonFormatVisitor

public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
 JavaType typeHint)
                             throws JsonMappingException

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 StdSerializer<T>

typeHint - Type of element (entity like property) being visited

Throws:

JsonMappingException

_integerListType

protected JavaType _integerListType(SerializerProvider prov)

useTimestamp

protected boolean useTimestamp(SerializerProvider provider)

_useTimestampExplicitOnly

protected boolean _useTimestampExplicitOnly(SerializerProvider provider)

useNanoseconds

protected boolean useNanoseconds(SerializerProvider provider)

serializeWithType

public void serializeWithType(Duration value,
 JsonGenerator g,
 SerializerProvider provider,
 TypeSerializer typeSer)
                       throws IOException

Description copied from class: JsonSerializer

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.

Overrides:

serializeWithType in class JsonSerializer<T>

Parameters:

value - Value to serialize; can not be null.

g - Generator used to output resulting Json content

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

typeSer - Type serializer to use for including type information

Throws:

IOException