fr.whimtrip.ext.jwhtscrapper.intfr.BasicObjectMapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of whimtrip-ext-scrapper Show documentation

Fully featured highly pluggable and customizable Java scrapping framework

The newest version!

package fr.whimtrip.ext.jwhtscrapper.intfr;

import fr.whimtrip.ext.jwhtscrapper.service.JacksonBasicObjectMapper;
import org.jetbrains.annotations.NotNull;

import java.io.IOException;

/**
 * Part of project jwht-scrapper
 * Created on 26/07/18
 *
 * 
 *     Object Mapper simple implementation allowing to easily plug
 *     another mapper that could handle 100% different processing
 *     unit to convert objects to POJOs.
 * 
 *
 *
 * @see JacksonBasicObjectMapper Default Jackson JSON to POJO implementation of
 *                               this interface.
 * @author Louis-wht
 * @since 1.0.0
 */
public interface BasicObjectMapper {

    /**
     * Will read a value from raw stringified HTTP body given a POJO class.
     * @param rawBody the raw HTTP stringified body to use to map it to a POJO instance.
     * @param mappedClazz the class to map the HTTP body to.
     * @param  the type of the class to map the HTTP body to.
     * @return the instanciated and mapped POJO instance.
     * @throws IOException if read operation cannot be properly performed.
     */
     U readValue(@NotNull final String rawBody, @NotNull final Class mappedClazz) throws IOException;

    /**
     * 
     *     Will read a value from raw stringified HTTP body given a POJO class.
     *     This method needs to deal with an existing, already instanciated POJO
     *     with possibly already existing default values.
     * 
     * @param rawBody the raw HTTP stringified body to use to map it to a POJO instance.
     * @param mappedClazz the class to map the HTTP body to.
     * @param obj the object to populate.
     * @param  the type of the class to map the HTTP body to.
     * @return the mapped POJO instance. must be the same as the instance given as a
     *         parameter.
     * @throws IOException if read operation cannot be properly performed.
     */
     U readValue(@NotNull final String rawBody, @NotNull final Class mappedClazz, @NotNull final U obj) throws IOException;
}