org.codehaus.jackson.map.DeserializationProblemHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jackson-mapper-asl Show documentation

Data Mapper package is a high-performance data binding package built on Jackson JSON processor

There is a newer version: 1.9.13

package org.codehaus.jackson.map;

import java.io.IOException;

import org.codehaus.jackson.JsonProcessingException;

/**
 * This is the class that can be registered (via
 * {@link DeserializationConfig} object owner by
 * {@link ObjectMapper}) to get calledn when a potentially
 * recoverable problem is encountered during deserialization
 * process. Handlers can try to resolve the problem, throw
 * an exception or do nothing.
 *
 * Default implementations for all methods implemented minimal
 * "do nothing" functionality, which is roughly equivalent to
 * not having a registered listener at all. This allows for
 * only implemented handler methods one is interested in, without
 * handling other cases.
 * 
 * @author tatu
 */
public abstract class DeserializationProblemHandler
{
    /**
     * Method called when a Json Map ("Object") entry with an unrecognized
     * name is encountered.
     * Content (supposedly) matching the property are accessible via
     * parser that can be obtained from passed deserialization context.
     * Handler can also choose to skip the content; if so, it MUST return
     * true to indicate it did handle property succesfully.
     * Skipping is usually done like so:
     *
     *  ctxt.getParser().skipChildren();
     *
     *
     * Note: version 1.2 added new deserialization feature
     * (DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES).
     * It will only have effect after handler is called, and only
     * if handler did not handle the problem.
     *
     * @param beanOrClass Either bean instance being deserialized (if one
     *   has been instantiated so far); or Class that indicates type that
     *   will be instantiated (if no instantiation done yet: for example
     *   when bean uses non-default constructors)
     * 
     * @return True if the problem was succesfully resolved (and content available
     *    used or skipped); false if listen
     */
    public boolean handleUnknownProperty(DeserializationContext ctxt, JsonDeserializer deserializer,
                                         Object beanOrClass, String propertyName)
        throws IOException, JsonProcessingException
    {
        return false;
    }
}