com.fasterxml.jackson.datatype.jsr310.ser

Class MonthDaySerializer

java.lang.Object

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

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

com.fasterxml.jackson.datatype.jsr310.ser.MonthDaySerializer

All Implemented Interfaces:

JsonFormatVisitable, SchemaAware, ContextualSerializer, Serializable

public class MonthDaySerializer
extends StdSerializer<T>

Serializer for Java 8 temporal MonthDays.

NOTE: unlike many other date/time type serializers, this serializer will only use Array notation if explicitly instructed to do so with JsonFormat (either directly or through per-type defaults) and NOT with global defaults.

Since:

2.7.1

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 and Description
protected 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 Boolean	_useTimestamp Flag that indicates that serialization must be done as the Java timestamp, regardless of other settings.
static MonthDaySerializer	INSTANCE

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

_handledType

Constructor Summary

Constructors

Constructor and Description
MonthDaySerializer(DateTimeFormatter formatter)

Method Summary

Modifier and Type	Method and Description
protected void	_acceptTimestampVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
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) Default implementation simply claims type is "string"; usually overriden by custom serializers.
void	serialize(MonthDay value, JsonGenerator generator, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeWithType(T value, JsonGenerator generator, SerializerProvider provider, TypeSerializer serializer) 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	useTimestamp(SerializerProvider provider)
protected com.fasterxml.jackson.datatype.jsr310.ser.JSR310FormattedSerializerBase<?>	withFeatures(Boolean writeZoneId)
protected MonthDaySerializer	withFormat(Boolean useTimestamp, DateTimeFormatter formatter)

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

createObjectNode, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, 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

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final MonthDaySerializer INSTANCE

_useTimestamp

protected final Boolean _useTimestamp

Flag that indicates that serialization must be done as the Java timestamp, 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.

Constructor Detail

MonthDaySerializer

public MonthDaySerializer(DateTimeFormatter formatter)

Method Detail

withFormat

protected MonthDaySerializer withFormat(Boolean useTimestamp,
                                        DateTimeFormatter formatter)

serialize

public void serialize(MonthDay value,
                      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<MonthDay>

Parameters:

value - 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

withFeatures

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

Since:

2.8

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 can not 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

getSchema

public JsonNode getSchema(SerializerProvider provider,
                          Type typeHint)

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

useTimestamp

protected boolean useTimestamp(SerializerProvider provider)

_useTimestampExplicitOnly

protected boolean _useTimestampExplicitOnly(SerializerProvider provider)

serializeWithType

public void serializeWithType(T value,
                              JsonGenerator generator,
                              SerializerProvider provider,
                              TypeSerializer serializer)
                       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.

generator - Generator used to output resulting Json content

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

serializer - Type serializer to use for including type information

Throws:

IOException