Class LocalDateTimeSerializer
- java.lang.Object
-
- com.fasterxml.jackson.databind.JsonSerializer<T>
-
- com.fasterxml.jackson.databind.ser.std.StdSerializer<T>
-
- com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer
-
- All Implemented Interfaces:
JsonFormatVisitable,SchemaAware,ContextualSerializer,Serializable
public class LocalDateTimeSerializer extends StdSerializer<T>
Serializer for Java 8 temporalLocalDateTimes.- 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 DateTimeFormatter_formatterSpecific 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#_useTimestampis true.protected JavaType_integerListTypeLazily constructedJavaTyperepresenting typeList<Integer>.protected JsonFormat.Shape_shapeprotected Boolean_useNanosecondsFlag that indicates that numeric timestamp values must be written using nanosecond timestamps if the datatype supports such resolution, regardless of other settings.protected Boolean_useTimestampFlag that indicates that serialization must be done as the Java timestamp, regardless of other settings.static LocalDateTimeSerializerINSTANCE-
Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedLocalDateTimeSerializer()protectedLocalDateTimeSerializer(LocalDateTimeSerializer base, Boolean useTimestamp, Boolean useNanoseconds, DateTimeFormatter f)LocalDateTimeSerializer(DateTimeFormatter f)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void_acceptTimestampVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)protected DateTimeFormatter_defaultFormatter()protected JavaType_integerListType(SerializerProvider prov)protected DateTimeFormatter_useDateTimeFormatter(SerializerProvider prov, JsonFormat.Value format)protected boolean_useTimestampExplicitOnly(SerializerProvider provider)voidacceptJsonFormatVisitor(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.JsonNodegetSchema(SerializerProvider provider, Type typeHint)Default implementation simply claims type is "string"; usually overriden by custom serializers.protected SerializationFeaturegetTimestampsFeature()Overridable method that determinesSerializationFeaturethat is used as the global default in determining if date/time value serialized should use numeric format ("timestamp") or not.protected JsonTokenserializationShape(SerializerProvider provider)Overridable helper method used fromJsonSerializer.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.voidserialize(LocalDateTime value, JsonGenerator g, SerializerProvider provider)Method that can be called to ask implementation to serialize values of type this serializer handles.voidserializeWithType(LocalDateTime 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 booleanuseNanoseconds(SerializerProvider provider)protected booleanuseTimestamp(SerializerProvider provider)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 com.fasterxml.jackson.datatype.jsr310.ser.JSR310FormattedSerializerBase<LocalDateTime>withFormat(Boolean useTimestamp, DateTimeFormatter f, 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
-
-
-
-
Field Detail
-
INSTANCE
public static final LocalDateTimeSerializer 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#_useTimestampis true.
-
_shape
protected final JsonFormat.Shape _shape
-
_integerListType
protected transient volatile JavaType _integerListType
Lazily constructedJavaTyperepresenting typeList<Integer>.- Since:
- 2.10
-
-
Constructor Detail
-
LocalDateTimeSerializer
protected LocalDateTimeSerializer()
-
LocalDateTimeSerializer
public LocalDateTimeSerializer(DateTimeFormatter f)
-
LocalDateTimeSerializer
protected LocalDateTimeSerializer(LocalDateTimeSerializer base, Boolean useTimestamp, Boolean useNanoseconds, DateTimeFormatter f)
-
-
Method Detail
-
withFormat
protected com.fasterxml.jackson.datatype.jsr310.ser.JSR310FormattedSerializerBase<LocalDateTime> withFormat(Boolean useTimestamp, DateTimeFormatter f, JsonFormat.Shape shape)
-
_defaultFormatter
protected DateTimeFormatter _defaultFormatter()
-
serialize
public void serialize(LocalDateTime value, JsonGenerator g, SerializerProvider provider) throws IOException
Description copied from class:JsonSerializerMethod that can be called to ask implementation to serialize values of type this serializer handles.- Specified by:
serializein classStdSerializer<LocalDateTime>- Parameters:
value- Value to serialize; can not be null.g- Generator used to output resulting Json contentprovider- Provider that can be used to get serializers for serializing Objects value contains, if any.- Throws:
IOException
-
serializeWithType
public void serializeWithType(LocalDateTime value, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws IOException
Description copied from class:JsonSerializerMethod 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
UnsupportedOperationExceptionto 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, asSTART-ARRAY/END-ARRAYandSTART-OBJECT/END-OBJECTpairs need to be properly handled with respect to serializing of contents.- Parameters:
value- Value to serialize; can not be null.g- Generator used to output resulting Json contentprovider- 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
-
serializationShape
protected JsonToken serializationShape(SerializerProvider provider)
Overridable helper method used fromJsonSerializer.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)
-
withFeatures
@Deprecated protected com.fasterxml.jackson.datatype.jsr310.ser.JSR310FormattedSerializerBase<?> withFeatures(Boolean writeZoneId)
Deprecated.- Since:
- 2.8
-
createContextual
public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) throws JsonMappingException
Description copied from interface:ContextualSerializerMethod 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:
createContextualin interfaceContextualSerializer- Parameters:
prov- Serializer provider to use for accessing config, other serializersproperty- 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
-
getSchema
public JsonNode getSchema(SerializerProvider provider, Type typeHint)
Description copied from class:StdSerializerDefault implementation simply claims type is "string"; usually overriden by custom serializers.- Specified by:
getSchemain interfaceSchemaAware- Overrides:
getSchemain classStdSerializer<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:StdSerializerDefault implementation specifies no format. This behavior is usually overriden by custom serializers.- Specified by:
acceptJsonFormatVisitorin interfaceJsonFormatVisitable- Overrides:
acceptJsonFormatVisitorin classStdSerializer<T>typeHint- Type of element (entity like property) being visited- Throws:
JsonMappingException
-
_acceptTimestampVisitor
protected void _acceptTimestampVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException
- Throws:
JsonMappingException
-
_integerListType
protected JavaType _integerListType(SerializerProvider prov)
-
getTimestampsFeature
protected SerializationFeature getTimestampsFeature()
Overridable method that determinesSerializationFeaturethat 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.
- Since:
- 2.10
-
useTimestamp
protected boolean useTimestamp(SerializerProvider provider)
-
_useTimestampExplicitOnly
protected boolean _useTimestampExplicitOnly(SerializerProvider provider)
-
useNanoseconds
protected boolean useNanoseconds(SerializerProvider provider)
-
_useDateTimeFormatter
protected DateTimeFormatter _useDateTimeFormatter(SerializerProvider prov, JsonFormat.Value format)
-
-