Top Description Constructors Methods
com.fasterxml.jackson.databind.ser

public abstract Class SerializerFactory

extends Object
Class Inheritance
Known Direct Subclasses
com.fasterxml.jackson.databind.ser.BasicSerializerFactory
Imports
com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.jsontype.TypeSerializer
Abstract class that defines API used by SerializerProvider to obtain actual JsonSerializer instances from multiple distinct factories.

Constructor Summary

AccessConstructor and Description
public
SerializerFactory()

Method Summary

Modifier and TypeMethod and Description
public JsonSerializer<Object>

Returns:

Serializer to use, if factory knows it; null if not (in which case default serializer is to be used)
createKeySerializer(SerializerProvider prov, JavaType
Declared type for Map keys
type, JsonSerializer<Object>
Default key serializer implementation to use, if no custom ones are found (may be null)
defaultImpl)

Method called to create serializer to use for serializing JSON property names (which must be output as JsonToken.FIELD_NAME) for Map that has specified declared key type, and is for specified property (or, if property is null, as root value)

public abstract JsonSerializer<Object>
createKeySerializer(SerializationConfig config, JavaType type, JsonSerializer<Object> defaultImpl)

Deprecated
public abstract JsonSerializer<Object>
createSerializer(SerializerProvider
Provider that needs to be used to resolve annotation-provided serializers (but NOT for others)
prov, JavaType baseType)

Method called to create (or, for immutable serializers, reuse) a serializer for given type.

public abstract TypeSerializer

Returns:

Type serializer to use for the base type, if one is needed; null if not.
createTypeSerializer(SerializationConfig config, JavaType
Declared type to use as the base type for type information serializer
baseType)

Method called to create a type information serializer for given base type, if one is needed.

public abstract SerializerFactory
withAdditionalKeySerializers(Serializers additional)

public abstract SerializerFactory
withAdditionalSerializers(Serializers additional)

Convenience method for creating a new factory instance with additional serializer provider; equivalent to calling 

   withConfig(getConfig().withAdditionalSerializers(additional));
public abstract SerializerFactory
withSerializerModifier(BeanSerializerModifier modifier)

Convenience method for creating a new factory instance with additional bean serializer modifier; equivalent to calling 

   withConfig(getConfig().withSerializerModifier(modifier));
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

SerializerFactoryback to summary
public SerializerFactory()

Method Detail

createKeySerializerback to summary
public JsonSerializer<Object> createKeySerializer(SerializerProvider prov, JavaType type, JsonSerializer<Object> defaultImpl) throws JsonMappingException

Method called to create serializer to use for serializing JSON property names (which must be output as JsonToken.FIELD_NAME) for Map that has specified declared key type, and is for specified property (or, if property is null, as root value)

Parameters
type:JavaType

Declared type for Map keys

defaultImpl:JsonSerializer<Object>

Default key serializer implementation to use, if no custom ones are found (may be null)

Returns:JsonSerializer<Object>

Serializer to use, if factory knows it; null if not (in which case default serializer is to be used)

Since
2.11
createKeySerializerback to summary
public abstract JsonSerializer<Object> createKeySerializer(SerializationConfig config, JavaType type, JsonSerializer<Object> defaultImpl) throws JsonMappingException

Deprecated

Annotations
@Deprecated
createSerializerback to summary
public abstract JsonSerializer<Object> createSerializer(SerializerProvider prov, JavaType baseType) throws JsonMappingException

Method called to create (or, for immutable serializers, reuse) a serializer for given type.

Parameters
prov:SerializerProvider

Provider that needs to be used to resolve annotation-provided serializers (but NOT for others)

Since
2.1 (earlier versions had method with different signature)
createTypeSerializerback to summary
public abstract TypeSerializer createTypeSerializer(SerializationConfig config, JavaType baseType) throws JsonMappingException

Method called to create a type information serializer for given base type, if one is needed. If not needed (no polymorphic handling configured), should return null.

Parameters
baseType:JavaType

Declared type to use as the base type for type information serializer

Returns:TypeSerializer

Type serializer to use for the base type, if one is needed; null if not.

withAdditionalKeySerializersback to summary
public abstract SerializerFactory withAdditionalKeySerializers(Serializers additional)
withAdditionalSerializersback to summary
public abstract SerializerFactory withAdditionalSerializers(Serializers additional)

Convenience method for creating a new factory instance with additional serializer provider; equivalent to calling 

   withConfig(getConfig().withAdditionalSerializers(additional));
withSerializerModifierback to summary
public abstract SerializerFactory withSerializerModifier(BeanSerializerModifier modifier)

Convenience method for creating a new factory instance with additional bean serializer modifier; equivalent to calling 

   withConfig(getConfig().withSerializerModifier(modifier));