com.fasterxml.jackson.databind.ser.std

Class NullSerializer

java.lang.Object

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

com.fasterxml.jackson.databind.ser.std.StdSerializer<java.lang.Object>

com.fasterxml.jackson.databind.ser.std.NullSerializer

All Implemented Interfaces:

JsonFormatVisitable, SchemaAware, java.io.Serializable

public class NullSerializer
extends StdSerializer<java.lang.Object>

This is a simple dummy serializer that will just output literal JSON null value whenever serialization is requested. Used as the default "null serializer" (which is used for serializing null object references unless overridden), as well as for some more exotic types (java.lang.Void).

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
static NullSerializer	instance

Method Summary

Modifier and Type	Method and Description
void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) Default implementation specifies no format.
JsonNode	getSchema(SerializerProvider provider, java.lang.reflect.Type typeHint) Default implementation simply claims type is "string"; usually overriden by custom serializers.
void	serialize(java.lang.Object value, JsonGenerator gen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeWithType(java.lang.Object value, JsonGenerator gen, SerializerProvider serializers, TypeSerializer typeSer) Although this method should rarely get called, for convenience we should override it, and handle it same way as "natural" types: by serializing exactly as is, without type decorations.

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

Methods inherited from class java.lang.Object

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

Field Detail

instance

public static final NullSerializer instance

Method Detail

serialize

public void serialize(java.lang.Object value,
                      JsonGenerator gen,
                      SerializerProvider provider)
               throws java.io.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<java.lang.Object>

Parameters:

value - Value to serialize; can not be null.

gen - Generator used to output resulting Json content

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

Throws:

java.io.IOException

serializeWithType

public void serializeWithType(java.lang.Object value,
                              JsonGenerator gen,
                              SerializerProvider serializers,
                              TypeSerializer typeSer)
                       throws java.io.IOException

Although this method should rarely get called, for convenience we should override it, and handle it same way as "natural" types: by serializing exactly as is, without type decorations. The most common possible use case is that of delegation by JSON filter; caller cannot know what kind of serializer it gets handed.

Overrides:

serializeWithType in class JsonSerializer<java.lang.Object>

Parameters:

value - Value to serialize; can not be null.

gen - Generator used to output resulting Json content

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

getSchema

public JsonNode getSchema(SerializerProvider provider,
                          java.lang.reflect.Type typeHint)
                   throws JsonMappingException

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<java.lang.Object>

Parameters:

provider - The serializer provider.

typeHint - A hint about the type.

Returns:

Json-schema for this serializer.

Throws:

JsonMappingException

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<java.lang.Object>

typeHint - Type of element (entity like property) being visited

Throws:

JsonMappingException