org.codehaus.jackson.map.ser
Class CustomSerializerFactory

java.lang.Object
  extended by org.codehaus.jackson.map.SerializerFactory
      extended by org.codehaus.jackson.map.ser.BasicSerializerFactory
          extended by org.codehaus.jackson.map.ser.BeanSerializerFactory
              extended by org.codehaus.jackson.map.ser.CustomSerializerFactory

public class CustomSerializerFactory
extends BeanSerializerFactory

Serializer factory implementation that allows for configuring mapping between types (classes) and serializers to use, by using multiple types of overrides. Existing mappings established by BeanSerializerFactory (and its super class, BasicSerializerFactory) are used if no overrides are defined.

Unlike base serializer factories (BasicSerializerFactory, BeanSerializerFactory), this factory is stateful because of configuration settings. It is thread-safe, however, as long as all configuration as done before using the factory -- a single instance can be shared between providers and mappers.

Configurations currently available are:

In near future, following features are planned to be added:


Nested Class Summary
 
Nested classes/interfaces inherited from class org.codehaus.jackson.map.ser.BasicSerializerFactory
BasicSerializerFactory.BooleanSerializer, BasicSerializerFactory.CalendarSerializer, BasicSerializerFactory.ClassSerializer, BasicSerializerFactory.DoubleSerializer, BasicSerializerFactory.EnumSerializer, BasicSerializerFactory.FloatSerializer, BasicSerializerFactory.IntegerSerializer, BasicSerializerFactory.IntLikeSerializer, BasicSerializerFactory.LongSerializer, BasicSerializerFactory.NullSerializer, BasicSerializerFactory.NumberSerializer, BasicSerializerFactory.SerializableSerializer, BasicSerializerFactory.SqlDateSerializer, BasicSerializerFactory.SqlTimeSerializer, BasicSerializerFactory.StringLikeSerializer<T>, BasicSerializerFactory.StringSerializer, BasicSerializerFactory.UtilDateSerializer
 
Field Summary
 
Fields inherited from class org.codehaus.jackson.map.ser.BeanSerializerFactory
instance
 
Constructor Summary
CustomSerializerFactory()
           
 
Method Summary
<T> void
addGenericMapping(Class<? extends T> type, JsonSerializer<T> ser)
          Method used to add a generic (transitive) mapping from specified class or its sub-classes into a serializer.
<T> void
addSpecificMapping(Class<? extends T> forClass, JsonSerializer<T> ser)
          Method used to add a mapping from specific type -- and only that type -- to specified serializer.
<T> JsonSerializer<T>
createSerializer(Class<T> type, SerializationConfig config)
          Main serializer constructor method.
 void setEnumSerializer(JsonSerializer<?> enumSer)
          Method that can be used to force specified serializer to be used for serializing all Enum instances.
 
Methods inherited from class org.codehaus.jackson.map.ser.BeanSerializerFactory
constructBeanSerializer, constructPropertyBuilder, findBeanProperties, findBeanSerializer, isPotentialBeanType, usesStaticTyping
 
Methods inherited from class org.codehaus.jackson.map.ser.BasicSerializerFactory
findSerializerByAddonType, findSerializerByLookup, findSerializerByPrimaryType, findSerializerFromAnnotation, getNullSerializer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CustomSerializerFactory

public CustomSerializerFactory()
Method Detail

addGenericMapping

public <T> void addGenericMapping(Class<? extends T> type,
                                  JsonSerializer<T> ser)
Method used to add a generic (transitive) mapping from specified class or its sub-classes into a serializer. When resolving a type into a serializer, explicit class is checked first, then immediate super-class, and so forth along inheritance chain. But if this fails, implemented interfaces are checked; ordering is done such that first interfaces implemented by the exact type are checked (in order returned by Class.getInterfaces()), then super-type's and so forth.

Note that adding generic mappings may lead to problems with sub-classing: if sub-classes add new properties, these may not get properly serialized.

Parameters:
type - Class for which specified serializer is to be used. May be more specific type than what serializer indicates, but must be compatible (same or sub-class)

addSpecificMapping

public <T> void addSpecificMapping(Class<? extends T> forClass,
                                   JsonSerializer<T> ser)
Method used to add a mapping from specific type -- and only that type -- to specified serializer. This means that binding is not used for sub-types. It also means that no such mappings are to be defined for abstract classes or interfaces: and if an attempt is made, IllegalArgumentException will be thrown to indicate caller error.

Parameters:
forClass - Class for which specified serializer is to be used. May be more specific type than what serializer indicates, but must be compatible (same or sub-class)

setEnumSerializer

public void setEnumSerializer(JsonSerializer<?> enumSer)
Method that can be used to force specified serializer to be used for serializing all Enum instances. This is most commonly used to specify serializers that call either enum.toString(), or modify value returned by enum.name() (such as upper- or lower-casing it).

Note: this serializer has lower precedence than that of specific types; so if a specific serializer is assigned to an Enum type, this serializer will NOT be used. It has higher precedence than generic mappings have however.


createSerializer

public <T> JsonSerializer<T> createSerializer(Class<T> type,
                                              SerializationConfig config)
Description copied from class: BeanSerializerFactory
Main serializer constructor method. We will have to be careful with respect to ordering of various method calls: essentially we want to reliably figure out which classes are standard types, and which are beans. The problem is that some bean Classes may implement standard interfaces (say, Iterable.

Note: sub-classes may choose to complete replace implementation, if they want to alter priority of serializer lookups.

Overrides:
createSerializer in class BeanSerializerFactory
Parameters:
type - Type to be serialized
config - Generic serialization configuration