org.testifyproject.fasterxml.jackson.databind.deser.ContextualKeyDeserializer Maven / Gradle / Ivy

Go to download
package org.testifyproject.testifyproject.fasterxml.jackson.databind.org.testifyproject.testifyprojectser;

import org.testifyproject.testifyproject.fasterxml.jackson.databind.*;

/**
 * Add-on interface that {@link KeyDeserializer}s can implement to get a callback
 * that can be used to create contextual instances of key org.testifyproject.testifyprojectserializer to use for
 * handling Map keys of supported type. This can be useful
 * for key org.testifyproject.testifyprojectserializers that can be configured by annotations, or should otherwise
 * have differing behavior org.testifyproject.testifyprojectpending on what kind of Map property keys are being org.testifyproject.testifyprojectserialized.
 */
public interface ContextualKeyDeserializer
{
    /**
     * Method called to see if a different (or differently configured) key org.testifyproject.testifyprojectserializer
     * is needed to org.testifyproject.testifyprojectserialize keys of specified Map 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.
     * 
     * @param ctxt Deserialization context to access configuration, additional 
     *    org.testifyproject.testifyprojectserializers that may be needed by this org.testifyproject.testifyprojectserializer
     * @param property Method, field or constructor parameter that org.testifyproject.testifyprojectclared Map for which
     *   contextual instance will be used. Will not be available when org.testifyproject.testifyprojectserializing root-level
     *   Map value; otherwise should not be null.
     * 
     * @return Key org.testifyproject.testifyprojectserializer to use for org.testifyproject.testifyprojectserializing keys specified Map property,
     *   may be this instance or a new instance.
     */
    public KeyDeserializer createContextual(DeserializationContext ctxt,
            BeanProperty property)
        throws JsonMappingException;
}