Class YearMonthSerializer
- java.lang.Object
-
- com.fasterxml.jackson.databind.JsonSerializer<T>
-
- com.fasterxml.jackson.databind.ser.std.StdSerializer<T>
-
- com.fasterxml.jackson.datatype.jsr310.ser.YearMonthSerializer
-
- All Implemented Interfaces:
JsonFormatVisitable,SchemaAware,ContextualSerializer,java.io.Serializable
public class YearMonthSerializer extends StdSerializer<T>
Serializer for Java 8 temporalYearMonths.- Since:
- 2.2
- 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 static YearMonthSerializerINSTANCE
-
Constructor Summary
Constructors Constructor Description YearMonthSerializer(java.time.format.DateTimeFormatter formatter)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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, java.lang.reflect.Type typeHint)Default implementation simply claims type is "string"; usually overriden by custom serializers.voidserialize(java.time.YearMonth value, JsonGenerator g, SerializerProvider provider)Method that can be called to ask implementation to serialize values of type this serializer handles.voidserializeWithType(java.time.YearMonth 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.-
Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer
getSchema, handledType, 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 YearMonthSerializer INSTANCE
-
-
Method Detail
-
serialize
public void serialize(java.time.YearMonth value, JsonGenerator g, SerializerProvider provider) throws java.io.IOExceptionDescription copied from class:JsonSerializerMethod that can be called to ask implementation to serialize values of type this serializer handles.- Specified by:
serializein classStdSerializer<java.time.YearMonth>- 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:
java.io.IOException
-
serializeWithType
public void serializeWithType(java.time.YearMonth value, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws java.io.IOExceptionDescription 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:
java.io.IOException
-
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, java.lang.reflect.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
-
-