Class DefaultSerializerProvider

    • Method Detail

      • copy

        public DefaultSerializerProvider copy()
        Method needed to ensure that ObjectMapper.copy() will work properly; specifically, that caches are cleared, but settings will otherwise remain identical; and that no sharing of state occurs.
        Since:
        2.5
      • includeFilterInstance

        public java.lang.Object includeFilterInstance​(BeanPropertyDefinition forProperty,
                                                      java.lang.Class<?> filterClass)
        Description copied from class: SerializerProvider
        Method that can be called to construct and configure JsonInclude filter instance, given a Class to instantiate (with default constructor, by default).
        Specified by:
        includeFilterInstance in class SerializerProvider
        Parameters:
        forProperty - (optional) If filter is created for a property, that property; `null` if filter created via defaulting, global or per-type.
      • findObjectId

        public WritableObjectId findObjectId​(java.lang.Object forPojo,
                                             ObjectIdGenerator<?> generatorType)
        Description copied from class: SerializerProvider
        Method called to find the Object Id for given POJO, if one has been generated. Will always return a non-null Object; contents vary depending on whether an Object Id already exists or not.
        Specified by:
        findObjectId in class SerializerProvider
      • hasSerializerFor

        public boolean hasSerializerFor​(java.lang.Class<?> cls,
                                        java.util.concurrent.atomic.AtomicReference<java.lang.Throwable> cause)
        Method that can be called to see if this serializer provider can find a serializer for an instance of given class.

        Note that no Exceptions are thrown, including unchecked ones: implementations are to swallow exceptions if necessary.

      • serializeValue

        public void serializeValue​(JsonGenerator gen,
                                   java.lang.Object value)
                            throws java.io.IOException
        The method to be called by ObjectMapper and ObjectWriter for serializing given value, using serializers that this provider has access to (via caching and/or creating new serializers as need be).
        Throws:
        java.io.IOException
      • serializeValue

        public void serializeValue​(JsonGenerator gen,
                                   java.lang.Object value,
                                   JavaType rootType)
                            throws java.io.IOException
        The method to be called by ObjectMapper and ObjectWriter for serializing given value (assumed to be of specified root type, instead of runtime type of value), using serializers that this provider has access to (via caching and/or creating new serializers as need be),
        Parameters:
        rootType - Type to use for locating serializer to use, instead of actual runtime type. Must be actual type, or one of its super types
        Throws:
        java.io.IOException
      • serializeValue

        public void serializeValue​(JsonGenerator gen,
                                   java.lang.Object value,
                                   JavaType rootType,
                                   JsonSerializer<java.lang.Object> ser)
                            throws java.io.IOException
        The method to be called by ObjectWriter for serializing given value (assumed to be of specified root type, instead of runtime type of value), when it may know specific JsonSerializer to use.
        Parameters:
        rootType - Type to use for locating serializer to use, instead of actual runtime type, if no serializer is passed
        ser - Root Serializer to use, if not null
        Throws:
        java.io.IOException
        Since:
        2.1
      • serializePolymorphic

        public void serializePolymorphic​(JsonGenerator gen,
                                         java.lang.Object value,
                                         JavaType rootType,
                                         JsonSerializer<java.lang.Object> valueSer,
                                         TypeSerializer typeSer)
                                  throws java.io.IOException
        Alternate serialization call used for polymorphic types, when TypeSerializer is already known, but the actual serializer may or may not be.
        Throws:
        java.io.IOException
        Since:
        2.6
      • cachedSerializersCount

        public int cachedSerializersCount()
        Method that can be used to determine how many serializers this provider is caching currently (if it does caching: default implementation does) Exact count depends on what kind of serializers get cached; default implementation caches all serializers, including ones that are eagerly constructed (for optimal access speed)

        The main use case for this method is to allow conditional flushing of serializer cache, if certain number of entries is reached.

      • flushCachedSerializers

        public void flushCachedSerializers()
        Method that will drop all serializers currently cached by this provider. This can be used to remove memory usage (in case some serializers are only used once or so), or to force re-construction of serializers after configuration changes for mapper than owns the provider.