fr.whimtrip.ext.jwhthtmltopojo.intrf.HtmlDeserializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of whimtrip-ext-htmltopojo Show documentation
Fully featured highly pluggable and customizable Java html to pojo reflection converter
There is a newer version: 1.0.2
Show newest version






package fr.whimtrip.ext.jwhthtmltopojo.intrf;

import fr.whimtrip.ext.jwhthtmltopojo.exception.ConversionException;
import fr.whimtrip.ext.jwhthtmltopojo.impl.ReplacerDeserializer;
import fr.whimtrip.ext.jwhthtmltopojo.impl.StringConcatenatorDeserializer;
import fr.whimtrip.ext.jwhthtmltopojo.impl.TextLengthSelectorDeserializer;

/**
 *
 * An Html Deserializer can be used to define deserialization hooks.
 *
 * There is two different deserialization processes, pre and post
 * deserialization. 
 *  
 *      
 *          Pre deserialization happens just after the raw string value
 *          has been gathered from the HTML element, it must return a
 *          string.
 *      
 *      
 *          Post deserialization happens after regex matching and pre
 *          deserialization and must return an object whose type converts
 *          back to the field's type.
 *      
 *  
 *
 *
 *  Implementations of an HtmlDeserializer features  {@link TextLengthSelectorDeserializer},
 *  {@link StringConcatenatorDeserializer}, {@link ReplacerDeserializer}.
 *
 *  
 *      To use an Html Deserializer on one of your fields, you should process
 *      as following :
 *  
 *
 *   *      @Selector(
 *          value = "some-css-query",
 *          useDeserializer = true,
 *          // if you want the pre conversion method to be called
 *          preConvert = true,
 *          // if you want the post conversion method to be called
 *          postConvert = true,
 *          deserializer = MyCustomDeserializer.class
 *      )
 *      private String myDeserializedString;
 *  
 *
 *
 * Part of project jwht-htmltopojo
 *
 * @author Louis-wht
 * @since 1.0.0
 */
public interface HtmlDeserializer extends Initiate {

    /**
     * Pre deserialization of the given String input raw value.
     *
     * 
     *     Pre deserialization happens just after the raw string value
     *     has been gathered from the HTML element, it must return a
     *     string.
     * 
     *
     * 
     *     A given HtmlDeserializer might implement this method with only :
     * 
     *      *     @Override
     *     public String deserializePreConversion(String value){
     *         return value;
     *     }
     * 
     *
     * @param value the value to pre deserialize
     * @return a string representing the pre deserialized value
     * @throws ConversionException if some input value is incorrect
     *                             and cannot be processed.
     */
    String deserializePreConversion(String value) throws ConversionException;


    /**
     * Post deserialization of the given String input raw value.
     *
     * 
     *    Post deserialization happens after regex matching and pre
     *    deserialization and must return an object whose type converts
     *    back to the field's type.
     * 
     *
     * 
     *     A given HtmlDeserializer might implement this method with only :
     * 
     *      *     @Override
     *     public String deserializePostConversion(String value){
     *         return value;
     *     }
     * 
     *
     * @param value the value to post deserialize
     * @return an output object directly of the type expected by the input
     *
     * @throws ConversionException if some input value is incorrect
     *                             and cannot be processed.
     */
    T deserializePostConversion(String value) throws ConversionException;

}