Module tools.jackson.databind

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

Class YearMonthSerializer

java.lang.Object

tools.jackson.databind.ValueSerializer<YearMonth>

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

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

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

tools.jackson.databind.ext.javatime.ser.YearMonthSerializer

All Implemented Interfaces:

JsonFormatVisitable

public class YearMonthSerializer
extends JSR310FormattedSerializerBase<YearMonth>

Serializer for Java 8 temporal YearMonths.

Since:

2.2

Nested Class Summary

Nested classes/interfaces inherited from class tools.jackson.databind.ValueSerializer

ValueSerializer.None

Field Summary

Fields

Modifier and Type	Field	Description
static final YearMonthSerializer	INSTANCE

Fields inherited from class tools.jackson.databind.ext.javatime.ser.JSR310FormattedSerializerBase

_formatter, _integerListType, _shape, _useNanoseconds, _useTimestamp

Fields inherited from class tools.jackson.databind.ser.std.StdSerializer

_handledType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	YearMonthSerializer()
	YearMonthSerializer(DateTimeFormatter formatter)
private	YearMonthSerializer(YearMonthSerializer base, DateTimeFormatter dtf, Boolean useTimestamp)

Method Summary

Modifier and Type	Method	Description
protected void	_acceptTimestampVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
protected void	_serializeAsArrayContents(YearMonth value, tools.jackson.core.JsonGenerator g, SerializationContext ctxt)
protected tools.jackson.core.JsonToken	serializationShape(SerializationContext ctxt)	Overridable helper method used from JSR310SerializerBase.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.
void	serialize(YearMonth value, tools.jackson.core.JsonGenerator g, SerializationContext ctxt)	Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeWithType(YearMonth value, tools.jackson.core.JsonGenerator g, SerializationContext ctxt, 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 YearMonthSerializer	withFormat(DateTimeFormatter dtf, Boolean useTimestamp, com.fasterxml.jackson.annotation.JsonFormat.Shape shape)

Methods inherited from class tools.jackson.databind.ext.javatime.ser.JSR310FormattedSerializerBase

_integerListType, _useDateTimeFormatter, _useTimestampExplicitOnly, acceptJsonFormatVisitor, createContextual, getTimestampsFeature, useNanoseconds, useTimestamp, useTimestampFromGlobalDefaults, withFeatures

Methods inherited from class tools.jackson.databind.ser.std.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 tools.jackson.databind.ValueSerializer

getDelegatee, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, resolve, unwrappingSerializer, usesObjectId, withFilterId, withFormatOverrides, 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 YearMonthSerializer INSTANCE

Constructor Details

YearMonthSerializer

protected YearMonthSerializer()

YearMonthSerializer

public YearMonthSerializer(DateTimeFormatter formatter)

YearMonthSerializer

private YearMonthSerializer(YearMonthSerializer base,
 DateTimeFormatter dtf,
 Boolean useTimestamp)

Method Details

withFormat

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

Specified by:

withFormat in class JSR310FormattedSerializerBase<YearMonth>

serialize

public void serialize(YearMonth value,
 tools.jackson.core.JsonGenerator g,
 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<YearMonth>

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.

Throws:

tools.jackson.core.JacksonException

serializeWithType

public void serializeWithType(YearMonth value,
 tools.jackson.core.JsonGenerator g,
 SerializationContext ctxt,
 TypeSerializer typeSer)
                       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, 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, ctxt);
  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 JSR310SerializerBase<YearMonth>

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:

tools.jackson.core.JacksonException

_serializeAsArrayContents

protected void _serializeAsArrayContents(YearMonth value,
 tools.jackson.core.JsonGenerator g,
 SerializationContext ctxt)
                                  throws tools.jackson.core.JacksonException

Throws:

tools.jackson.core.JacksonException

_acceptTimestampVisitor

protected void _acceptTimestampVisitor(JsonFormatVisitorWrapper visitor,
 JavaType typeHint)

Overrides:

_acceptTimestampVisitor in class JSR310FormattedSerializerBase<YearMonth>

serializationShape

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

Description copied from class: JSR310SerializerBase

Overridable helper method used from JSR310SerializerBase.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.

Specified by:

serializationShape in class JSR310SerializerBase<YearMonth>