Class DateTimeSerializerBase<T>
- java.lang.Object
-
- com.fasterxml.jackson.databind.JsonSerializer<T>
-
- com.fasterxml.jackson.databind.ser.std.StdSerializer<T>
-
- com.fasterxml.jackson.databind.ser.std.StdScalarSerializer<T>
-
- com.fasterxml.jackson.databind.ser.std.DateTimeSerializerBase<T>
-
- All Implemented Interfaces:
JsonFormatVisitable,SchemaAware,ContextualSerializer,Serializable
- Direct Known Subclasses:
CalendarSerializer,DateSerializer,SqlDateSerializer
public abstract class DateTimeSerializerBase<T> extends StdScalarSerializer<T> implements ContextualSerializer
- 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 DateFormat_customFormatSpecific 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 AtomicReference<DateFormat>_reusedCustomFormatIf_customFormatis used, we will try to reuse instances in simplest possible form; thread-safe, but without overhead ofThreadLocal(not from code, but wrt retaining of possibly large number of format instances over all threads, properties with custom formats).protected Boolean_useTimestampFlag that indicates that serialization must be done as the Java timestamp, regardless of other settings.-
Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedDateTimeSerializerBase(Class<T> type, Boolean useTimestamp, DateFormat customFormat)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void_acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint, boolean asNumber)protected boolean_asTimestamp(SerializerProvider serializers)protected void_serializeAsString(Date value, com.fasterxml.jackson.core.JsonGenerator g, SerializerProvider provider)protected abstract long_timestamp(T value)voidacceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)Default implementation specifies no format.JsonSerializer<?>createContextual(SerializerProvider serializers, BeanProperty property)Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.JsonNodegetSchema(SerializerProvider serializers, Type typeHint)Default implementation simply claims type is "string"; usually overriden by custom serializers.booleanisEmpty(SerializerProvider serializers, T value)Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).abstract voidserialize(T value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider serializers)Method that can be called to ask implementation to serialize values of type this serializer handles.abstract DateTimeSerializerBase<T>withFormat(Boolean timestamp, DateFormat customFormat)-
Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdScalarSerializer
serializeWithType
-
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, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId, withFilterId
-
-
-
-
Field Detail
-
_useTimestamp
protected final Boolean _useTimestamp
Flag that indicates that serialization must be done as the Java timestamp, regardless of other settings.
-
_customFormat
protected final DateFormat _customFormat
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.
-
_reusedCustomFormat
protected final AtomicReference<DateFormat> _reusedCustomFormat
If_customFormatis used, we will try to reuse instances in simplest possible form; thread-safe, but without overhead ofThreadLocal(not from code, but wrt retaining of possibly large number of format instances over all threads, properties with custom formats).- Since:
- 2.9
-
-
Constructor Detail
-
DateTimeSerializerBase
protected DateTimeSerializerBase(Class<T> type, Boolean useTimestamp, DateFormat customFormat)
-
-
Method Detail
-
withFormat
public abstract DateTimeSerializerBase<T> withFormat(Boolean timestamp, DateFormat customFormat)
-
createContextual
public JsonSerializer<?> createContextual(SerializerProvider serializers, 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:
serializers- 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
-
isEmpty
public boolean isEmpty(SerializerProvider serializers, T value)
Description copied from class:JsonSerializerMethod called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).Default implementation will consider only null values to be empty.
NOTE: replaces
JsonSerializer.isEmpty(Object), which was deprecated in 2.5- Overrides:
isEmptyin classJsonSerializer<T>
-
_timestamp
protected abstract long _timestamp(T value)
-
getSchema
public JsonNode getSchema(SerializerProvider serializers, Type typeHint)
Description copied from class:StdSerializerDefault implementation simply claims type is "string"; usually overriden by custom serializers.- Specified by:
getSchemain interfaceSchemaAware- Overrides:
getSchemain classStdScalarSerializer<T>- Parameters:
serializers- 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 classStdScalarSerializer<T>typeHint- Type of element (entity like property) being visited- Throws:
JsonMappingException
-
serialize
public abstract void serialize(T value, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider serializers) 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<T>- Parameters:
value- Value to serialize; can not be null.gen- Generator used to output resulting Json contentserializers- Provider that can be used to get serializers for serializing Objects value contains, if any.- Throws:
IOException
-
_asTimestamp
protected boolean _asTimestamp(SerializerProvider serializers)
-
_acceptJsonFormatVisitor
protected void _acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint, boolean asNumber) throws JsonMappingException
- Throws:
JsonMappingException
-
_serializeAsString
protected void _serializeAsString(Date value, com.fasterxml.jackson.core.JsonGenerator g, SerializerProvider provider) throws IOException
- Throws:
IOException- Since:
- 2.9
-
-